From aeb265b6c03ba063b950d2e0dc68353b7af260c6 Mon Sep 17 00:00:00 2001 From: James Miao Date: Tue, 21 Sep 2021 18:26:27 -0700 Subject: [PATCH 1/7] Add README section to troubleshoot fleet creation and additional support --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1098dfe5..d7620170 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,28 @@ The Amazon GameLift Plug-in for Unity is compatible only with officially support ### Where are the logs? An additional error log file related to the Unity game project can be found in the following location: **logs/amazon-gamelift-plugin-logs[YYYYMMDD].txt**. Note, that the log file is created once a day. -## For contributors +### Why did my deployment fail? + +If your deployment failed, go to **AWS CloudFormation console > **, and check out event tab to see which +resource failed and why. + +If you are using the following deployment scenarios: +- "SPOT Fleets with Queue and Custom Matchmaker" +- "FlexMatch" + +You might encounter "GeneralServiceException", this exception means that your fleet creation failed, and this can happen +if your AWS account is limited by GameLift (e.g. new account, invalid payment details, etc.). Please go to **GameLift +AWS console > Service Limits**, and request for limit increase on your account, then work with AWS customer support to +get your account limit lifted. + +### I need help! + +If you are blocked, please don't hesitate to reach out for support via: +* [AWS Support Center](https://console.aws.amazon.com/support/home) +* [GitHub issues](https://github.com/aws/amazon-gamelift-plugin-unity/issues) +* [AWS game tech forums](https://forums.awsgametech.com/) + +## For GitHub Contributors ### How to set up the project development environment? From ccd74190b909b6e9d4e0ea0892ac51ba6d72295a Mon Sep 17 00:00:00 2001 From: James Miao Date: Tue, 21 Sep 2021 18:30:43 -0700 Subject: [PATCH 2/7] Run formatter on all README files --- GameLift-SampleGame/README.md | 100 ++++++-- .../Editor/Resources/CloudFormation/README.md | 47 ++-- README.md | 226 +++++++++++++----- 3 files changed, 265 insertions(+), 108 deletions(-) diff --git a/GameLift-SampleGame/README.md b/GameLift-SampleGame/README.md index ffbe82b8..f2cb1b33 100644 --- a/GameLift-SampleGame/README.md +++ b/GameLift-SampleGame/README.md @@ -2,51 +2,80 @@ ## Summary -This sample code shows how to set up a basic GameLift server and client for games using the Unity Game Engine. It consists of a Unity project that has been configured to be built in two ways, as a SERVER or a CLIENT. In CLIENT configuration, no preprocessor symbols are needed. In SERVER configuration, the UNITY_SERVER symbol needs to be defined in Unity Project Settings. +This sample code shows how to set up a basic GameLift server and client for games using the Unity Game Engine. It +consists of a Unity project that has been configured to be built in two ways, as a SERVER or a CLIENT. In CLIENT +configuration, no preprocessor symbols are needed. In SERVER configuration, the UNITY_SERVER symbol needs to be defined +in Unity Project Settings. -The code can be viewed in the C# scripts in the `Assets\Scripts` folder. Client-only code is under Client; server-only code is under server, and everything else needs to be shared between them. +The code can be viewed in the C# scripts in the `Assets\Scripts` folder. Client-only code is under Client; server-only +code is under server, and everything else needs to be shared between them. -The server and can be deployed to GameLift and other infrastructire can be created with the plugin UI. One or more clients can be run on your local machine and they can connect to the server to join a game. When some players have arrived the game can be started. +The server and can be deployed to GameLift and other infrastructire can be created with the plugin UI. One or more +clients can be run on your local machine and they can connect to the server to join a game. When some players have +arrived the game can be started. -The idea of the game is to use the numeric keypad keys to match up pairs, triplets, quadruplets etc. matching colored dots on a three by three board. Accordingly the middle dot is 5, the left dot on the middle row is 4, both of the blue dots. Pressing the numeric keypad keys 4 and 5 simultaneously makes a move and matches the two blue dots for a score of two. Alternatively match the purple dots by pressing 1, 3 and 8 for a score of three. Matching four and upward dots in one move is possible, however note that due to the way that keyboards are wired, certain combinations may not be possible on some hardware. +The idea of the game is to use the numeric keypad keys to match up pairs, triplets, quadruplets etc. matching colored +dots on a three by three board. Accordingly the middle dot is 5, the left dot on the middle row is 4, both of the blue +dots. Pressing the numeric keypad keys 4 and 5 simultaneously makes a move and matches the two blue dots for a score of +two. Alternatively match the purple dots by pressing 1, 3 and 8 for a score of three. Matching four and upward dots in +one move is possible, however note that due to the way that keyboards are wired, certain combinations may not be +possible on some hardware. ## How to Play -1. When first start the game client, sign up and log in. If you are using local mode, i.e. the endpoint is `http://localhost`, you can enter any values in username and password to login +1. When first start the game client, sign up and log in. If you are using local mode, i.e. the endpoint + is `http://localhost`, you can enter any values in username and password to login 1. Press "ENTER" to get ready. There needs to be at least 2 players to be ready for the game to start. 1. Use NUMPAD keys to match colored dots ## Setting up the game client -The client will need the AWS Region, Cognito Client ID and API Gateway Endpoint. They can be set in Unity, the scriptable object is at `Assets\Settings\GameLiftClientSettings`. -When the scenario is deployed, its outputs are also displayed in the Deployment window. Copy them out of the window and paste in the GameLiftClientSettings. Anyone playing against you on a different machine should use the same settings to join your server, so you could distribute the client, if you wanted that. +The client will need the AWS Region, Cognito Client ID and API Gateway Endpoint. They can be set in Unity, the +scriptable object is at `Assets\Settings\GameLiftClientSettings`. When the scenario is deployed, its outputs are also +displayed in the Deployment window. Copy them out of the window and paste in the GameLiftClientSettings. Anyone playing +against you on a different machine should use the same settings to join your server, so you could distribute the client, +if you wanted that. -Make sure that the scenes are in the "Scenes In Build" list in the File/Build Settings window. For running the smaple in Unity editor, start the BootstrapScene scene. +Make sure that the scenes are in the "Scenes In Build" list in the File/Build Settings window. For running the smaple in +Unity editor, start the BootstrapScene scene. ## Building the project -1. To build client, just open the File/Build Settings window, make sure you have "Server Build" unchecked, and press "Build". Select a client build folder. -1. To build server, in the File/Build Settings window, press "Player Settings", and add a UNITY_SERVER to Scripting Define Symbols. Restart Unity. Open the File/Build Settings window, make sure you have "Server Build" checked, and press "Build". Select a server build folder. +1. To build client, just open the File/Build Settings window, make sure you have "Server Build" unchecked, and press " + Build". Select a client build folder. +1. To build server, in the File/Build Settings window, press "Player Settings", and add a UNITY_SERVER to Scripting + Define Symbols. Restart Unity. Open the File/Build Settings window, make sure you have "Server Build" checked, and + press "Build". Select a server build folder. You can also use "GameLift / Configure Sample Server" and "GameLift / Configure Sample Client" in Unity main menu. ## How to deploy a server to GameLift -Deploy a scenario to AWS from Unity with the plugin's GameLift/Deployment window. The fleet has to be in the active state before you can connect to it. You can check it at https://console.aws.amazon.com/gamelift/home (make sure you select your region on the page). +Deploy a scenario to AWS from Unity with the plugin's GameLift/Deployment window. The fleet has to be in the active +state before you can connect to it. You can check it at https://console.aws.amazon.com/gamelift/home (make sure you +select your region on the page). ## Understandng and using the Client The client operates in three modes depending on what you are doing for a server. -1. The game client will try to locate a local server, and if not found, attempt to find a GameLift server (with the default alias or one supplied on the command line. If a server cannot be reached, the client will go into a serverless standalone mode. +1. The game client will try to locate a local server, and if not found, attempt to find a GameLift server (with the + default alias or one supplied on the command line. If a server cannot be reached, the client will go into a + serverless standalone mode. -1. It will never again try to look for a server. This is by design. Just kill the client and start another if you want another mode. +1. It will never again try to look for a server. This is by design. Just kill the client and start another if you want + another mode. -"Hello World" appears in each client, and the clients enter a synchronized 'attract' mode (a color change animation), driven by the server. +"Hello World" appears in each client, and the clients enter a synchronized 'attract' mode (a color change animation), +driven by the server. -1. Press RETURN inside each client window to start. When all clients have pressed return, the game begins. GO! appears in each client. +1. Press RETURN inside each client window to start. When all clients have pressed return, the game begins. GO! appears + in each client. -1. You should be able to press numeric keypad keys in one client or another to make matches and increase your score. All clients should see the matches being made, and everyone’s scores. If you have a laptop, some function key combination may be required to activate numeric keypad keys. In rare cases, no numeric keypad maybe available. Keys Y U I, H J K, N M comma may be used instead. The game will score matches until the ESC key is pressed. +1. You should be able to press numeric keypad keys in one client or another to make matches and increase your score. All + clients should see the matches being made, and everyone’s scores. If you have a laptop, some function key combination + may be required to activate numeric keypad keys. In rare cases, no numeric keypad maybe available. Keys Y U I, H J K, + N M comma may be used instead. The game will score matches until the ESC key is pressed. ### Log Output @@ -56,13 +85,22 @@ You should find your logs in the folder: where `%UserProfile%` is usually `C:\Users\`\ -If you have multiple clients and servers running locally by the way, they are all writing to the same file making the logs messy and illegible. If you want to change the target log file, run the client or the server from command line with "-logFile " option. It will be helpful in the GameLift fleet to have your server log in `C:\game\`. The server is set up to upload its logs over 1 hour old to a more permanent storage on S3. To access them there, call the GetGameSessionLog API: https://docs.aws.amazon.com/cli/latest/reference/gamelift/get-game-session-log.html +If you have multiple clients and servers running locally by the way, they are all writing to the same file making the +logs messy and illegible. If you want to change the target log file, run the client or the server from command line +with "-logFile " option. It will be helpful in the GameLift fleet to have your server log in `C:\game\`. The +server is set up to upload its logs over 1 hour old to a more permanent storage on S3. To access them there, call the +GetGameSessionLog API: https://docs.aws.amazon.com/cli/latest/reference/gamelift/get-game-session-log.html ### Client LOCAL and GAMELIFT modes -Local mode uses a server running on the local machine. Clients started on the local machine will detect the local server and try to connect to it. Four player multiplayer is possible, and the server and all four clients must be run locally. GameLift Local is required for local mode. You can use any email and password, there is no check. +Local mode uses a server running on the local machine. Clients started on the local machine will detect the local server +and try to connect to it. Four player multiplayer is possible, and the server and all four clients must be run locally. +GameLift Local is required for local mode. You can use any email and password, there is no check. -GameLift mode uses an internet connection for authentication and server connection, a GameLift fleet running in an AWS account to provide server functionality, and no server must be run locally. To use GameLift mode, ensure that the connection is available, and then run only the client on the local machine. Four player multiplayer is possible, across the Internet (depending on the scenario used). +GameLift mode uses an internet connection for authentication and server connection, a GameLift fleet running in an AWS +account to provide server functionality, and no server must be run locally. To use GameLift mode, ensure that the +connection is available, and then run only the client on the local machine. Four player multiplayer is possible, across +the Internet (depending on the scenario used). #### How to use in LOCAL mode with GameLift Local @@ -72,7 +110,8 @@ Local mode uses a server running on the local machine, and the client will use G 1. Press "Download JRE" and install the Java 8 Runtime. -1. Press "Download GameLift Local" and unpack the GameLift Local JAR from inside the GameLift Managed Servers SDK package. +1. Press "Download GameLift Local" and unpack the GameLift Local JAR from inside the GameLift Managed Servers SDK + package. 1. Set the path of GameLiftLocal.jar in the plugin UI. @@ -80,20 +119,29 @@ Local mode uses a server running on the local machine, and the client will use G 1. Start the GameLift Local and the server by pressing `Deploy & Run`. -1. In Unity editor, in the scriptable object `Assets\Settings\GameLiftClientSettings`, set API Gateway Endpoint to `http://localhost:`. +1. In Unity editor, in the scriptable object `Assets\Settings\GameLiftClientSettings`, set API Gateway Endpoint + to `http://localhost:`. -1. Build the local client. Run one to four clients. The clients should work as usual but connect to the local game server. +1. Build the local client. Run one to four clients. The clients should work as usual but connect to the local game + server. Clients will report `CLIENT | LOCAL | CONNECTED 1UP`, `CLIENT | LOCAL | CONNECTED 2UP`, etc. #### How to use in GAMELIFT mode -1. To use the GameLift server in GameLift mode, simply run the clients without a local server running, and the game will try to connect. Clients can be on different machines and play together. NOTE, the corporate network (or VPN connection to the corporate network) can disrupt the client’s ability to reach the GameLift fleet, due to blocked ports. Port permissions must be set on the fleet to allow access on port 33430. (NB other ports can be specified to the server with -port 33430 or other values in [33430-33440] range if needed; See the section for setting up your own GameLift server below.) +1. To use the GameLift server in GameLift mode, simply run the clients without a local server running, and the game will + try to connect. Clients can be on different machines and play together. NOTE, the corporate network (or VPN + connection to the corporate network) can disrupt the client’s ability to reach the GameLift fleet, due to blocked + ports. Port permissions must be set on the fleet to allow access on port 33430. (NB other ports can be specified to + the server with -port 33430 or other values in [33430-33440] range if needed; See the section for setting up your own + GameLift server below.) Clients will report `CLIENT | GAMELIFT | CONNECTED 1UP`, `CLIENT | GAMELIFT | CONNECTED 2UP`, etc. - ## Running Tests -1. Unit tests can be found at **GameLift-SampleGame\Assets\Tests\Editor\Unit**, or in the **SampleTests.Unit project** in your IDE. They can be run from the Unity Editor: **Window > General > Test Runner, EditMode**. -1. Play mode integration UI tests can be found at **GameLift-SampleGame\Assets\Tests\UI**, or in the **SampleTests.UI project** in your IDE. They can be run from the Unity Editor: **Window > General > Test Runner, PlayMode**. These tests need **GameLift-SampleGame\UiTestSettings.json** filled with your test parameters. +1. Unit tests can be found at **GameLift-SampleGame\Assets\Tests\Editor\Unit**, or in the **SampleTests.Unit project** + in your IDE. They can be run from the Unity Editor: **Window > General > Test Runner, EditMode**. +1. Play mode integration UI tests can be found at **GameLift-SampleGame\Assets\Tests\UI**, or in the **SampleTests.UI + project** in your IDE. They can be run from the Unity Editor: **Window > General > Test Runner, PlayMode**. These + tests need **GameLift-SampleGame\UiTestSettings.json** filled with your test parameters. diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md index 144fc74d..4e600c5b 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md @@ -17,47 +17,60 @@ 1. Create a new directories under `CloudFormation` directory named `scenario<##>_` 1. Create the following files: - * `/cloudformation.yml` -- This will contain the CFN template of the deployment scenario - * `/parameters.json` -- This will contain the parameters to the CFN template - * `/lambda/*.py` -- These are the lambda function source code that will be uploaded to s3 and used to create the lambda functions - * `/Deployer.cs` -- This will contain the necessary data for the deployment scenario to be displayed in the plugin UI - * `/tests/test.py` -- This will run integ tests against a deployed scenario (the scenario is already deployed with `bin/deploy_cfn.py`) -1. Load the project in Unity, and .meta files will be generated for you. These .meta files will need to be committed eventually + * `/cloudformation.yml` -- This will contain the CFN template of the deployment scenario + * `/parameters.json` -- This will contain the parameters to the CFN template + * `/lambda/*.py` -- These are the lambda function source code that will be uploaded to s3 and used to + create the lambda functions + * `/Deployer.cs` -- This will contain the necessary data for the deployment scenario to be displayed + in the plugin UI + * `/tests/test.py` -- This will run integ tests against a deployed scenario (the scenario is already + deployed with `bin/deploy_cfn.py`) +1. Load the project in Unity, and .meta files will be generated for you. These .meta files will need to be committed + eventually ## Update & test an existing deployment scenario 1. Use Amazon GameLift Plug-in for Unity to create a CloudFormation stack - * If the deployment failed immediately, it means the template is mal-formatted. Check the error output to locate the error. + * If the deployment failed immediately, it means the template is mal-formatted. Check the error output to locate the + error. * If the deployment started but eventually failed, go to CloudFormation console to find out why. 1. Modify `GAME_NAME` and `REGION` in `python3 /tests/test.py` to match the stack you deployed 1. Run `aws configure` to set your default AWS credentials to match the account in which your stack was deployed 1. Run `python3 /tests/test.py` to verify that the scenario is still working 1. Make any updates to the template and test, then repeat the last 3 steps, i.e. redeploy, wait, test - * To speed up iteration, you can remove the `Fleet` resource in the template and replace all of its references to a hard-coded resource ID/ARN + * To speed up iteration, you can remove the `Fleet` resource in the template and replace all of its references to a + hard-coded resource ID/ARN ## Run Load Test * Reference: https://aws.amazon.com/blogs/compute/load-testing-a-web-applications-serverless-backend/ + 1. Install Artillery: https://artillery.io/docs/guides/getting-started/installing-artillery.html 1. `cd common/tests` 1. Get an id-token 1. Run `aws configure` to set your default AWS credentials with permissions to your Cognito resources - 1. Sign-up for a temporary account: `aws cognito-idp sign-up --client-id --username --password ` - 1. Confirm the account sign-up: `aws cognito-idp admin-confirm-sign-up --user-pool-id --username ` - 1. Initiate auth: `aws cognito-idp initiate-auth --client-id --auth-flow USER_PASSWORD_AUTH --auth-parameters USERNAME=,PASSWORD=` + 1. Sign-up for a temporary + account: `aws cognito-idp sign-up --client-id --username --password ` + 1. Confirm the account + sign-up: `aws cognito-idp admin-confirm-sign-up --user-pool-id --username ` + 1. Initiate + auth: `aws cognito-idp initiate-auth --client-id --auth-flow USER_PASSWORD_AUTH --auth-parameters USERNAME=,PASSWORD=` 1. Copy the id-token from `.AuthenticationResult.IdToken` 1. Modify `loadtest.yml` - 1. `target` -- Your API gateway endpoint, e.g. `https://1234567xyz.execute-api.us-west-2.amazonaws.com/v1` + 1. `target` -- Your API gateway endpoint, e.g. `https://1234567xyz.execute-api.us-west-2.amazonaws.com/v1` 1. `Authorization` -- id-token retrieved from the above steps 1. Run `artillery run loadtest.yml` - * Artillery reports every 10 seconds, so you should see `10 * arrivalRate` number of results in each report. For most APIs, you should expect to see 2xx codes; - however, due to the Web Application Firewall throttling rules (See `WebACL` resource in the CloudFormation templates), you will start seeing 403 errors if the - requesting rate is too high. This is to be expected! + * Artillery reports every 10 seconds, so you should see `10 * arrivalRate` number of results in each report. For + most APIs, you should expect to see 2xx codes; however, due to the Web Application Firewall throttling rules ( + See `WebACL` resource in the CloudFormation templates), you will start seeing 403 errors if the requesting rate is + too high. This is to be expected! ## Before you submit a pull request -1. Run `cfn-format --write /cloudformation.yml`, example: `cfn-format --write scenario1_auth_only/cloudformation.yml` - * NOTE: a caveat in cfn-format is that it does not preserve comments, we'll need to manually add copyrights back once the formatter completes. +1. Run `cfn-format --write /cloudformation.yml`, + example: `cfn-format --write scenario1_auth_only/cloudformation.yml` + * NOTE: a caveat in cfn-format is that it does not preserve comments, we'll need to manually add copyrights back + once the formatter completes. ``` # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: MIT-0 diff --git a/README.md b/README.md index d7620170..fc440172 100644 --- a/README.md +++ b/README.md @@ -7,68 +7,135 @@ ## Overview -Amazon GameLift provides tools for preparing your multiplayer games and custom game servers to run on the GameLift service. The GameLift SDKs contain libraries needed to enable game clients and servers to communicate with the GameLift service. The Amazon GameLift Plug-in for Unity makes it easier to access GameLift resources and integrate GameLift into your Unity game. You can use the Plug-in for Unity to access GameLift APIs and deploy AWS CloudFormation templates for common gaming scenarios. Pre-built sample scenarios include: - -* Auth Only — This scenario creates a game backend service that performs only player authentication and no game server capability. It creates a Cognito user pool to store player authentication information, as well as an API gateway REST endpoint backed up AWS Lambda handlers to start a game and view game connection information. The Lambda handler always returns a 501 Error (Unimplemented). - -* Single-Region Fleet — This scenario creates a game backend service with a single GameLift fleet. After player authenticates and starts a game (with a `POST` request to `/start_game`), a AWS Lambda handler searches for an existing viable game session with an open player slot on the fleet via `gamelift::SearchGameSession`. If an open slot is not found, the Lambda creates a new game session via `gamelift::CreateGameSession`. Once game start is request, the game client should poll the back end (with `POST` requests to `/get_game_connection`) to receive a viable game session. - -* Multi-Region Fleets with Queue and Custom Matchmaker — In this scenario, Amazon GameLift queues are used in conjunction with a custom matchmaker. The custom matchmaker forms matches by grouping up the oldest players in the waiting pool. The customer matchmaker does not consider other factors like skills or latency. When there are enough players for a match, the Lambda calls `GameLift:StartGameSessionPlacement` to start a queue placement. Once the placement is done, GameLift publishes a message to the SNS topic in the backend service, which triggers a Lambda function to store the placement details along with the game conection details to a DynamoDB table. Subquent GetGameConnection calls would read from this table and return the connection information to the game client. - -* SPOT Fleets with Queue and Custom Matchmaker — This This scenario is the same as Multi-Region Fleets with Queue and Custom Matchmaker except it configures three fleets. Two of the fleets are SPOT fleets containing nuanced instance types to provide durability for SPOT unavilabilities; the third fleet is an ON_DEMAND fleet to serve as a backup in case the other SPOT fleets go unviable. Using a GameLift queue can keep availability high and cost low. For more information and best practices about queues, see [Setting up GameLift queues for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html). - -* FlexMatch — This scenario uses GameLift FlexMatch, customizable matchmaking service for multiplayer games. On StartGame requests, a Lambda creates matchmaking ticket via `gamelift:StartMatchmaking`, and a separate lambda listen to FlexMatch events similar to the queue example above. This deployment scenario also uses a low frequency poller to describe incomplete tickets via `gamelift::DescribeMatchmaking`. The incomplete tickets are periodically described so they are not discarded by GameLift. This is a best practice recommended by [Track Matchmaking Events](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html#match-client-track). For more information on FlexMatch, see [What is GameLift FlexMatch?](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) - -Each sample scenario uses an AWS CloudFormation template to create a stack with all of the resources needed for the sample game. You can remove the resources by deleting the corresponding AWS CloudFormation stack. - -The Amazon GameLift Plug-in for Unity also includes a sample game you can use to explore the basics of integrating your game with Amazon GameLift. - -For more information about Amazon GameLift, see [Amazon GameLift](https://docs.aws.amazon.com/gamelift). For more information about the Amazon GameLift Plug-in for Unity, see [Integrating Games with the Amazon GameLift Plug-in for Unity](https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html). +Amazon GameLift provides tools for preparing your multiplayer games and custom game servers to run on the GameLift +service. The GameLift SDKs contain libraries needed to enable game clients and servers to communicate with the GameLift +service. The Amazon GameLift Plug-in for Unity makes it easier to access GameLift resources and integrate GameLift into +your Unity game. You can use the Plug-in for Unity to access GameLift APIs and deploy AWS CloudFormation templates for +common gaming scenarios. Pre-built sample scenarios include: + +* Auth Only — This scenario creates a game backend service that performs only player authentication and no game server + capability. It creates a Cognito user pool to store player authentication information, as well as an API gateway REST + endpoint backed up AWS Lambda handlers to start a game and view game connection information. The Lambda handler always + returns a 501 Error (Unimplemented). + +* Single-Region Fleet — This scenario creates a game backend service with a single GameLift fleet. After player + authenticates and starts a game (with a `POST` request to `/start_game`), a AWS Lambda handler searches for an + existing viable game session with an open player slot on the fleet via `gamelift::SearchGameSession`. If an open slot + is not found, the Lambda creates a new game session via `gamelift::CreateGameSession`. Once game start is request, the + game client should poll the back end (with `POST` requests to `/get_game_connection`) to receive a viable game + session. + +* Multi-Region Fleets with Queue and Custom Matchmaker — In this scenario, Amazon GameLift queues are used in + conjunction with a custom matchmaker. The custom matchmaker forms matches by grouping up the oldest players in the + waiting pool. The customer matchmaker does not consider other factors like skills or latency. When there are enough + players for a match, the Lambda calls `GameLift:StartGameSessionPlacement` to start a queue placement. Once the + placement is done, GameLift publishes a message to the SNS topic in the backend service, which triggers a Lambda + function to store the placement details along with the game conection details to a DynamoDB table. Subquent + GetGameConnection calls would read from this table and return the connection information to the game client. + +* SPOT Fleets with Queue and Custom Matchmaker — This This scenario is the same as Multi-Region Fleets with Queue and + Custom Matchmaker except it configures three fleets. Two of the fleets are SPOT fleets containing nuanced instance + types to provide durability for SPOT unavilabilities; the third fleet is an ON_DEMAND fleet to serve as a backup in + case the other SPOT fleets go unviable. Using a GameLift queue can keep availability high and cost low. For more + information and best practices about queues, + see [Setting up GameLift queues for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) + . + +* FlexMatch — This scenario uses GameLift FlexMatch, customizable matchmaking service for multiplayer games. On + StartGame requests, a Lambda creates matchmaking ticket via `gamelift:StartMatchmaking`, and a separate lambda listen + to FlexMatch events similar to the queue example above. This deployment scenario also uses a low frequency poller to + describe incomplete tickets via `gamelift::DescribeMatchmaking`. The incomplete tickets are periodically described so + they are not discarded by GameLift. This is a best practice recommended + by [Track Matchmaking Events](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html#match-client-track) + . For more information on FlexMatch, + see [What is GameLift FlexMatch?](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) + +Each sample scenario uses an AWS CloudFormation template to create a stack with all of the resources needed for the +sample game. You can remove the resources by deleting the corresponding AWS CloudFormation stack. + +The Amazon GameLift Plug-in for Unity also includes a sample game you can use to explore the basics of integrating your +game with Amazon GameLift. + +For more information about Amazon GameLift, see [Amazon GameLift](https://docs.aws.amazon.com/gamelift). For more +information about the Amazon GameLift Plug-in for Unity, +see [Integrating Games with the Amazon GameLift Plug-in for Unity](https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html) +. ## Installing the Amazon GameLift Plug-in for Unity -1. Download the Amazon GameLift Plug-in for Unity. You can find the latest version on the **Amazon GameLift Plug-in for Unity** GitHub repository. Under the [latest release](https://github.com/aws/amazon-gamelift-plugin-unity/releases), select Assets and download the `com.amazonaws.gamelift-.tgz` file. +1. Download the Amazon GameLift Plug-in for Unity. You can find the latest version on the **Amazon GameLift Plug-in for + Unity** GitHub repository. Under the [latest release](https://github.com/aws/amazon-gamelift-plugin-unity/releases), + select Assets and download the `com.amazonaws.gamelift-.tgz` file. 2. Launch Unity and select a project. 3. On the top menu bar, select **Window**, and then choose **Package Manager**. 4. In the **Package Manager** tab, under the tab, select **+**, and then choose **Add package from tarball...**. -5. In the **Select packages on disk** window, select the file **com.amazonaws.gamelift-1.0.0.tgz**, and then choose Open. -6. Once the plug-in is loaded, **GameLift** will be added as a new option on the Unity top menu bar. It may take a few minutes to install and recompile scripts. The **GameLift Plug-in Settings** tab will automatically open once the installation and compliation complete. -7. Go to **GameLift Plug-in Settings > SDK** tab, choose **Use .NET 4.x**. This will override the current API compatibility level to 4.x for the Unity project Player Settings. This is required because GameLift Server SDK only supports .NET 4.5 currently. +5. In the **Select packages on disk** window, select the file **com.amazonaws.gamelift-1.0.0.tgz**, and then choose + Open. +6. Once the plug-in is loaded, **GameLift** will be added as a new option on the Unity top menu bar. It may take a few + minutes to install and recompile scripts. The **GameLift Plug-in Settings** tab will automatically open once the + installation and compliation complete. +7. Go to **GameLift Plug-in Settings > SDK** tab, choose **Use .NET 4.x**. This will override the current API + compatibility level to 4.x for the Unity project Player Settings. This is required because GameLift Server SDK only + supports .NET 4.5 currently. ## Setting up for Local Testing -1. In Unity, on the **GameLift Plug-in Settings**, select **Test** tab, then **Download GameLift Local**. This will automatically open your web browser and ask where you would like the the testing tools to be downloaded (`GameLift_.zip`, e.g. `GameLift_06_03_2021.zip`). Some browser may be set to not asking for the download location, so please check your download directory to locate the zip file that was automatically downloaded. +1. In Unity, on the **GameLift Plug-in Settings**, select **Test** tab, then **Download GameLift Local**. This will + automatically open your web browser and ask where you would like the the testing tools to be + downloaded (`GameLift_.zip`, e.g. `GameLift_06_03_2021.zip`). Some browser may be set to not asking for the + download location, so please check your download directory to locate the zip file that was automatically downloaded. 2. Unzip the file downloaded -3. Go back to **GameLift Plug-in Settings**, select **GameLift Local Path** to configure the filepath of the `GameLiftLocal.jar` in the plug-in -4. If you haven't installed JRE, select **Install JRE** to download and install JRE from the official website. If you already have JRE installed, but the plug-in still shows "Not Configured" for JRE, then follow [this guide](https://www.java.com/en/download/help/path.html) to add the JRE `bin` directory to your Windows `PATH` system environment variable. - * NOTE: If you have JDK installed instead of JRE, this plug-in still show "Not Configured" for the JRE configuration (See Issue #9). As long as your java PATH is configured correctly in system environment variable (i.e. you are able to execute `java` in command prompt), then you can ignore the "Not Configured" warning. +3. Go back to **GameLift Plug-in Settings**, select **GameLift Local Path** to configure the filepath of + the `GameLiftLocal.jar` in the plug-in +4. If you haven't installed JRE, select **Install JRE** to download and install JRE from the official website. If you + already have JRE installed, but the plug-in still shows "Not Configured" for JRE, then + follow [this guide](https://www.java.com/en/download/help/path.html) to add the JRE `bin` directory to your + Windows `PATH` system environment variable. + * NOTE: If you have JDK installed instead of JRE, this plug-in still show "Not Configured" for the JRE + configuration (See Issue #9). As long as your java PATH is configured correctly in system environment variable ( + i.e. you are able to execute `java` in command prompt), then you can ignore the "Not Configured" warning. 5. Open **Local Testing UI** -6. Set the path to your GameLift SDK integrated server executabe (If you don't have one, see the below section to build a sample game server) +6. Set the path to your GameLift SDK integrated server executabe (If you don't have one, see the below section to build + a sample game server) 7. Select **Deploy and Run** - * This will automatically execute GameLift Local (via `java -jar -p `), and then after 10 seconds, execute the game server executable -8. If the GameLift Server SDK is configured correctly in your server executable, you should see `Healthcheck status: true` in GameLift Local terminal + * This will automatically execute GameLift Local (via `java -jar -p `), and then + after 10 seconds, execute the game server executable +8. If the GameLift Server SDK is configured correctly in your server executable, you should + see `Healthcheck status: true` in GameLift Local terminal ## Importing and running the sample game locally 1. In Unity, on the top menu bar, select **GameLift**, and then choose **Import Sample Game**. 2. In the **Import Sample Game** window, choose **Import** to import the game and all of its assets and dependencies. -3. In Unity, on the menu, select **GameLift**, and then choose **Apply Sample Server Build Settings**. After the game server settings are configured, Unity will recompile assets. -4. In Unity, on the menu, select **File**, and then choose **Build Settings...**, confirm Server Build is checked, choose **Build**, and then select a build folder. +3. In Unity, on the menu, select **GameLift**, and then choose **Apply Sample Server Build Settings**. After the game + server settings are configured, Unity will recompile assets. +4. In Unity, on the menu, select **File**, and then choose **Build Settings...**, confirm Server Build is checked, + choose **Build**, and then select a build folder. 5. Unity will build the sample game server, placing the executable and required assets in the specified build folder. 6. Close the build window. -7. In Unity, on the menu, select **GameLift**, and then choose **Apply Sample Client Build Settings**. After the game client settings are configured, Unity will recompile assets. -8. In Unity, on the menu, select **Go To Client Settings**. This will display an Inspector tab on the right side of the Unity screen. In the **GameLift Client Settings** tab, choose **Local Testing Mode**. -9. Build the game client. In Unity, on the menu, select **File**, and then choose **Build Settings...**, confirm **Server Build** is not checked, choose **Build**, and then select a build folder (This build folder should be different from the Server build folder). +7. In Unity, on the menu, select **GameLift**, and then choose **Apply Sample Client Build Settings**. After the game + client settings are configured, Unity will recompile assets. +8. In Unity, on the menu, select **Go To Client Settings**. This will display an Inspector tab on the right side of the + Unity screen. In the **GameLift Client Settings** tab, choose **Local Testing Mode**. +9. Build the game client. In Unity, on the menu, select **File**, and then choose **Build Settings...**, confirm ** + Server Build** is not checked, choose **Build**, and then select a build folder (This build folder should be + different from the Server build folder). 10. Unity will build the sample game client, placing the executable and required assets in the specified build folder. 11. Close the build window. -12. The game server and client are built. In the next few steps, you run the game and see how it interacts with GameLift. +12. The game server and client are built. In the next few steps, you run the game and see how it interacts with + GameLift. 13. In Unity, in the Plug-in for Unity tab, select the **Test** tab. 14. In the Test pane, select **Open Local Test UI**. -15. In the Local Testing window, specify a **Game Server .exe File Path**. The path must include the executable name. For example, `C:/MyGame/GameServer/MyGameServer.exe`. -16. Select **Deploy and Run**. The Plug-in for Unity will launch the game server and open a GameLift Local log window. The windows will contain log messages including messages sent between the game server and GameLift Local. -17. Launch the game client. You can find it in the build location you specified when building the sample game client. To test multiple player interactivity, you should launch at least 2 game clients. -18. In the GameLift Sample Game, provide an email and password and then select Log In. The email and password are not validated and are not used in Local Testing mode. -19. In the GameLift Sample Game, choose **Start**. The game client will look for a game session. If one cannot be found, it will create a game session. The game client then starts the game session. You can see game activity in the logs. +15. In the Local Testing window, specify a **Game Server .exe File Path**. The path must include the executable name. + For example, `C:/MyGame/GameServer/MyGameServer.exe`. +16. Select **Deploy and Run**. The Plug-in for Unity will launch the game server and open a GameLift Local log window. + The windows will contain log messages including messages sent between the game server and GameLift Local. +17. Launch the game client. You can find it in the build location you specified when building the sample game client. To + test multiple player interactivity, you should launch at least 2 game clients. +18. In the GameLift Sample Game, provide an email and password and then select Log In. The email and password are not + validated and are not used in Local Testing mode. +19. In the GameLift Sample Game, choose **Start**. The game client will look for a game session. If one cannot be found, + it will create a game session. The game client then starts the game session. You can see game activity in the logs. 20. Press `Enter` on all game clients to notify the server that the player is ready. 21. Once the game starts, press NUMPAD keys to match and clear dots off the grid. 22. In the game client, choose Quit or close the window to stop the game client. @@ -78,32 +145,51 @@ For more information about Amazon GameLift, see [Amazon GameLift](https://docs. ### First, update your credentials and account bootstrap location: -1. Update your credentials. In Unity, in the Plug-in for Unity tab, select the **Deploy** tab, -and then create new credentials or select existing credentials. -2. Update the account bootstrap location. In the **Deploy** pane, select **Update Account Bootstrap**. In the Account Bootstrapping window, you can choose an existing Amazon S3 bucket or create a new Amazon S3 bucket. The bootstrap location is an Amazon S3 bucket used during deployment. It is used to store game server assets and other dependencies. The AWS Region you select for the bucket must be the same Region you will use for the sample scenario deployment. +1. Update your credentials. In Unity, in the Plug-in for Unity tab, select the **Deploy** tab, and then create new + credentials or select existing credentials. +2. Update the account bootstrap location. In the **Deploy** pane, select **Update Account Bootstrap**. In the Account + Bootstrapping window, you can choose an existing Amazon S3 bucket or create a new Amazon S3 bucket. The bootstrap + location is an Amazon S3 bucket used during deployment. It is used to store game server assets and other + dependencies. The AWS Region you select for the bucket must be the same Region you will use for the sample scenario + deployment. ### Next, deploy a sample scenario: 1. In Unity, in the Plug-in for Unity tab, select the **Deploy** tab. 2. In the Deploy pane, select **Open Deployment UI**. -3. In the Deployment window, select a scenario. The **Auth Only** scenario does not require a server executable and can deploy quickly. All other scenarios require a server path and server executable and can take about 30 minutes to deploy. -4. Specify a **Game Name**. It must be unique. It will be used as part of the AWS CloudFormation stack name when the scenario is deployed. For example, if you specify **MySampleGame**, the corresponding AWS CloudFormation stack will be named **GameLiftPluginForUnity-MySampleGame**. -5. Select the **Game Server Build Folder Path**. The build folder path points to the folder containing the server executable and dependencies. For example, "c:/SampleGame/GameServer". You will not be able to select a build folder path if it is not required by the chosen scenario. -6. Select the **Game Server Build .exe File Path**. The build executable file path points to the game server executable. For example, "c:/SampleGame/GameServer/SampleGame.exe". You will not be able to select a build executable file path if it is not required by the chosen scenario. -7. Select **Start Deployment** to initiate deployment of the scenario. You can follow the status of the update in the Deployment window under Current State. -8. When the scenario completes deployment, **Current State** will be updated to include the **Cognito Client ID** and **API Gateway Endpoint**. -9. To update sample game settings, on the Unity menu, choose **Go To Client Connection Settings**. This will display an Inspector tab on the right side of the Unity screen. Make sure **Local Testing Mode** is not selected. -10. Use the API Gateway endpoint value to specify API Gateway Endpoint and the Amazon Cognito client ID to specify the Coginito Client ID. Select the same AWS Region you used for the scenario deployment. You can then rebuild and run the sample game client using the deployed scenario resources. - +3. In the Deployment window, select a scenario. The **Auth Only** scenario does not require a server executable and can + deploy quickly. All other scenarios require a server path and server executable and can take about 30 minutes to + deploy. +4. Specify a **Game Name**. It must be unique. It will be used as part of the AWS CloudFormation stack name when the + scenario is deployed. For example, if you specify **MySampleGame**, the corresponding AWS CloudFormation stack will + be named **GameLiftPluginForUnity-MySampleGame**. +5. Select the **Game Server Build Folder Path**. The build folder path points to the folder containing the server + executable and dependencies. For example, "c:/SampleGame/GameServer". You will not be able to select a build folder + path if it is not required by the chosen scenario. +6. Select the **Game Server Build .exe File Path**. The build executable file path points to the game server executable. + For example, "c:/SampleGame/GameServer/SampleGame.exe". You will not be able to select a build executable file path + if it is not required by the chosen scenario. +7. Select **Start Deployment** to initiate deployment of the scenario. You can follow the status of the update in the + Deployment window under Current State. +8. When the scenario completes deployment, **Current State** will be updated to include the **Cognito Client ID** and ** + API Gateway Endpoint**. +9. To update sample game settings, on the Unity menu, choose **Go To Client Connection Settings**. This will display an + Inspector tab on the right side of the Unity screen. Make sure **Local Testing Mode** is not selected. +10. Use the API Gateway endpoint value to specify API Gateway Endpoint and the Amazon Cognito client ID to specify the + Coginito Client ID. Select the same AWS Region you used for the scenario deployment. You can then rebuild and run + the sample game client using the deployed scenario resources. ## FAQ ### What Unity versions are supported? -The Amazon GameLift Plug-in for Unity is compatible only with officially supported versions of Unity 2019.4 LTS and 2020.3 LTS for Windows. +The Amazon GameLift Plug-in for Unity is compatible only with officially supported versions of Unity 2019.4 LTS and +2020.3 LTS for Windows. ### Where are the logs? -An additional error log file related to the Unity game project can be found in the following location: **logs/amazon-gamelift-plugin-logs[YYYYMMDD].txt**. Note, that the log file is created once a day. + +An additional error log file related to the Unity game project can be found in the following location: ** +logs/amazon-gamelift-plugin-logs[YYYYMMDD].txt**. Note, that the log file is created once a day. ### Why did my deployment fail? @@ -111,6 +197,7 @@ If your deployment failed, go to **AWS CloudFormation console > ** resource failed and why. If you are using the following deployment scenarios: + - "SPOT Fleets with Queue and Custom Matchmaker" - "FlexMatch" @@ -122,6 +209,7 @@ get your account limit lifted. ### I need help! If you are blocked, please don't hesitate to reach out for support via: + * [AWS Support Center](https://console.aws.amazon.com/support/home) * [GitHub issues](https://github.com/aws/amazon-gamelift-plugin-unity/issues) * [AWS game tech forums](https://forums.awsgametech.com/) @@ -130,23 +218,30 @@ If you are blocked, please don't hesitate to reach out for support via: ### How to set up the project development environment? -MS Windows OS is required. To build the Plug-in, you need to install some dependencies. This will require administrator rights on your machine: +MS Windows OS is required. To build the Plug-in, you need to install some dependencies. This will require administrator +rights on your machine: + * A supported Unity version - * You also need to add target Unity editor folder (e.g. **C:\Program Files\Unity\Hub\Editor\\Editor\\**) to the Windows PATH environment variable. + * You also need to add target Unity editor folder (e.g. **C:\Program Files\Unity\Hub\Editor\\Editor\\**) to + the Windows PATH environment variable. * Visual Studio 2019 (can be installed with Unity) -* .NET 4.5 Developer Pack to build the Server SDK (NOTE: 4.5.1 or 4.5.2 does not work.) Due to [.NET 4.5 reaching end of life](https://dotnet.microsoft.com/download/dotnet-framework/net45). You can only install 4.5 by following these steps: - 1. Open the Visual Studio Installer application. You should find your Visual Studio installation. - 2. Press Modify on your installation. - 3. Go to the Individual components tab. - 4. Check ".NET 4.5 Framework targeting pack", and press "Modify". -* .NET 4.7.1 Developer Pack to build AmazonGameLiftPlugin.Core. This can be downloaded at https://dotnet.microsoft.com/download/visual-studio-sdks, or as a part of MS Visual Studio. +* .NET 4.5 Developer Pack to build the Server SDK (NOTE: 4.5.1 or 4.5.2 does not work.) Due + to [.NET 4.5 reaching end of life](https://dotnet.microsoft.com/download/dotnet-framework/net45). You can only install + 4.5 by following these steps: + 1. Open the Visual Studio Installer application. You should find your Visual Studio installation. + 2. Press Modify on your installation. + 3. Go to the Individual components tab. + 4. Check ".NET 4.5 Framework targeting pack", and press "Modify". +* .NET 4.7.1 Developer Pack to build AmazonGameLiftPlugin.Core. This can be downloaded + at https://dotnet.microsoft.com/download/visual-studio-sdks, or as a part of MS Visual Studio. ### How to make changes to the plugin UI? 1. Clone the **amazon-gamelift-plugin-unity** repository 2. In Unity Hub, open project, and select `GameLift-Unity` directory as the project root 3. Make changes to the plugin code, and Unity should recompile after each change -4. To enable Unity debug mode and set breakpoint in the code, see: https://docs.unity3d.com/Manual/ManagedCodeDebugging.html +4. To enable Unity debug mode and set breakpoint in the code, + see: https://docs.unity3d.com/Manual/ManagedCodeDebugging.html 5. Once changes are made, run the Editor unit tests via **Window > General > Test Runner, Edit Mode** ### How to make changes to the Plugin Core Library? @@ -163,9 +258,10 @@ MS Windows OS is required. To build the Plug-in, you need to install some depend 3. Run `bin\windows\setup.ps1` to build dlls 4. Run `bin\windows\build.ps1` to bundle the plugin into a tarball (.tgz) file -The redistributable Plug-in files are located at **GameLift-Unity\Assets\com.amazonaws.gamelift**. -If you want to update the sample game, open the GameLift-SampleGame project in Unity and run the main menu command at **Assets > Export Sample**. -If you want to update the custom scenario sample, open the GameLift-Unity project in Unity and run the main menu command at **Assets > Export Custom Scenario**. +The redistributable Plug-in files are located at **GameLift-Unity\Assets\com.amazonaws.gamelift**. If you want to update +the sample game, open the GameLift-SampleGame project in Unity and run the main menu command at **Assets > Export +Sample**. If you want to update the custom scenario sample, open the GameLift-Unity project in Unity and run the main +menu command at **Assets > Export Custom Scenario**. ## License From 15b1258c8fe7ce2c807f258a077957d82926d91e Mon Sep 17 00:00:00 2001 From: James Miao Date: Tue, 21 Sep 2021 18:38:44 -0700 Subject: [PATCH 3/7] Update deployment scenario help link to the correct AWS Documentation (#28) Co-authored-by: James Miao --- GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs index 63783cc6..e4c81eca 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs @@ -10,7 +10,7 @@ internal static class Urls public const string AwsGameLiftLocal = "https://gamelift-release.s3-us-west-2.amazonaws.com/GameLift_06_03_2021.zip"; public const string AwsGameTechForums = "https://forums.awsgametech.com/"; public const string AwsHelpCredentials = "https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html"; - public const string AwsHelpDeployment = "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public const string AwsHelpDeployment = "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public const string AwsHelpGameLiftLocal = "https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing-local.html"; public const string AwsHelpGameLiftUnity = "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; public const string AwsS3Console = "https://s3.console.aws.amazon.com/s3/home"; From 06534085b57794c9d17954b6163a05a18e123093 Mon Sep 17 00:00:00 2001 From: James Miao Date: Wed, 22 Sep 2021 09:22:46 -0700 Subject: [PATCH 4/7] Update individual deployment scenario help URLs (#29) * Update deployment scenario help URLs * Change url from sample to deployment scenarios Co-authored-by: James Miao --- .../Resources/CloudFormation/scenario1_auth_only/Deployer.cs | 2 +- .../Resources/CloudFormation/scenario2_single_fleet/Deployer.cs | 2 +- .../Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs | 2 +- .../Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs | 2 +- .../Resources/CloudFormation/scenario5_flexmatch/Deployer.cs | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs index 99c58a5f..af0797b1 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs @@ -18,7 +18,7 @@ public sealed class Deployer : DeployerBase "This CloudFormation template sets up a minimal game backend service with only 1 functionality -- player authentication. " + "Lambda handler to start a game and view game connection information are stubbed to always return 501 error (Unimplemented)."; - public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public override string ScenarioFolder => "scenario1_auth_only"; diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs index 12563755..68f693aa 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs @@ -19,7 +19,7 @@ public sealed class Deployer : DeployerBase + "After player authenticates and start a game via POST /start_game, a lambda handler searches for an existing viable game session with open player slot on the fleet, and if not found, creates a new game session. " + "The game client is then expected to poll POST /get_game_connection to receive a viable game session."; - public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public override string ScenarioFolder => "scenario2_single_fleet"; diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs index f67bc7a4..29ea3f47 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs @@ -19,7 +19,7 @@ public sealed class Deployer : DeployerBase + "For simplicity sake, this custom matchmaker form matches by taking the oldest players in the waiting pool and not considering any other factors such as skills or latency. " + "Once the group of players to form matches is identified, a lambda function calls GameLift:StartGameSessionPlacement to start a queue placement."; - public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public override string ScenarioFolder => "scenario3_mrf_queue"; diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs index a9634b73..fbcc4d66 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs @@ -18,7 +18,7 @@ public sealed class Deployer : DeployerBase "This CloudFormation template sets up the exact same scenario as 'Multi-Region Fleets', except that 3 fleets are created instead of 1, with 2 of the fleets being SPOT fleets containing nuanced instance types. " + "This is to demonstrate the best practices in using GameLift queues to keep availability high and cost low."; - public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public override string ScenarioFolder => "scenario4_spot_fleets"; diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs index fb4346ed..ed870616 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs +++ b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs @@ -19,7 +19,7 @@ public sealed class Deployer : DeployerBase + "The template demonstrates best practices in acquiring the matchmaking ticket status, " + "by listening to FlexMatch events in conjunction with a low frequency poller to ensure incomplete tickets are periodically pinged and therefore are not discarded by GameLift."; - public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html"; + public override string HelpUrl => "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in-scenario.html"; public override string ScenarioFolder => "scenario5_flexmatch"; From 7cd470fe46dcca7cedbee206a7f37c8a8f5c6451 Mon Sep 17 00:00:00 2001 From: James Miao Date: Tue, 28 Sep 2021 14:11:50 -0700 Subject: [PATCH 5/7] Restructure repository files to comply to the Unity Package standards (#33) * Move AmazonGameLiftPlugin.Core to Runtime/Core * Move GameLift-SampleGame to Samples~/SampleGame * Move GameLift-Unity to Editor; Move CustomScenario to Samples~ * Update release scripts; Add .npmignore for npm-pack * Bump version to 1.1.0; Update CHANGELOG * Fix plugin version * Fix changelog and package.json typos Co-authored-by: James Miao --- .gitattributes | 47 - .gitignore | 6 +- .npmignore | 5 + AmazonGameLiftPlugin.Core/.editorconfig | 263 - AmazonGameLiftPlugin.Core/.gitignore | 351 - .../AmazonGameLiftPlugin.Core.Tests.csproj | 141 - .../packages.config | 18 - .../AmazonGameLiftPlugin.Core.sln | 36 - .../AmazonGameLiftPlugin.Core.csproj | 194 - .../Properties/AssemblyInfo.cs | 36 - .../AmazonGameLiftPlugin.Core/packages.config | 17 - CHANGELOG.md | 14 + ...SDK.GameLift.xml.meta => CHANGELOG.md.meta | 2 +- ...mation.xml.meta => CODE_OF_CONDUCT.md.meta | 2 +- ...yProvider.xml.meta => CONTRIBUTING.md.meta | 2 +- .../Editor.meta => Editor.meta | 0 Editor/AmazonGameLiftPlugin.Editor.asmdef | 20 + .../AmazonGameLiftPlugin.Editor.asmdef.meta | 0 .../Editor => Editor}/AssemblyInfo.cs | 0 .../Editor => Editor}/AssemblyInfo.cs.meta | 0 .../Editor => Editor}/AssetNames.cs | 0 .../Editor => Editor}/AssetNames.cs.meta | 0 .../Editor => Editor}/Bootstrap.meta | 0 .../Bootstrap/BootstrapBucketFormatter.cs | 0 .../BootstrapBucketFormatter.cs.meta | 0 .../Bootstrap/BootstrapSettings.cs | 0 .../Bootstrap/BootstrapSettings.cs.meta | 0 .../Bootstrap/BootstrapSettingsFactory.cs | 0 .../BootstrapSettingsFactory.cs.meta | 0 .../Bootstrap/BootstrapWindow.cs | 0 .../Bootstrap/BootstrapWindow.cs.meta | 0 .../BucketLifecyclePolicyTextProvider.cs | 0 .../BucketLifecyclePolicyTextProvider.cs.meta | 0 ...ucketLifecyclePolicyTextProviderFactory.cs | 0 ...LifecyclePolicyTextProviderFactory.cs.meta | 0 .../Bootstrap/BucketUrlFormatter.cs | 0 .../Bootstrap/BucketUrlFormatter.cs.meta | 0 .../Bootstrap/IBucketNameFormatter.cs | 0 .../Bootstrap/IBucketNameFormatter.cs.meta | 0 .../Bootstrap/RegionBootstrap.cs | 0 .../Bootstrap/RegionBootstrap.cs.meta | 0 .../Editor => Editor}/Controls.meta | 0 .../Controls/ControlDrawer.cs | 0 .../Controls/ControlDrawer.cs.meta | 0 .../Controls/ControlDrawerFactory.cs | 0 .../Controls/ControlDrawerFactory.cs.meta | 0 .../Editor => Editor}/Controls/Dialog.cs | 0 .../Editor => Editor}/Controls/Dialog.cs.meta | 0 .../Controls/DialogAction.cs | 0 .../Controls/DialogAction.cs.meta | 0 .../Controls/GuiLayoutImageSequenceDrawer.cs | 0 .../GuiLayoutImageSequenceDrawer.cs.meta | 0 .../Controls/ImageSequenceDrawer.cs | 0 .../Controls/ImageSequenceDrawer.cs.meta | 0 .../Controls/SpinnerDrawerFactory.cs | 0 .../Controls/SpinnerDrawerFactory.cs.meta | 0 .../Editor => Editor}/Controls/StatusLabel.cs | 0 .../Controls/StatusLabel.cs.meta | 0 .../Editor => Editor}/CoreAPI.meta | 0 .../AmazonGameLiftPlugin.EditorCoreAPI.asmdef | 18 + ...onGameLiftPlugin.EditorCoreAPI.asmdef.meta | 0 .../Editor => Editor}/CoreAPI/AssemblyInfo.cs | 0 .../CoreAPI/AssemblyInfo.cs.meta | 0 .../CoreAPI/BootstrapUtility.cs | 0 .../CoreAPI/BootstrapUtility.cs.meta | 0 .../CoreAPI/ChangeSetExecutionStatus.cs | 0 .../CoreAPI/ChangeSetExecutionStatus.cs.meta | 0 .../CoreAPI/ConfirmChangesDelegate.cs | 0 .../CoreAPI/ConfirmChangesDelegate.cs.meta | 0 .../Editor => Editor}/CoreAPI/CoreApi.cs | 0 .../Editor => Editor}/CoreAPI/CoreApi.cs.meta | 0 .../Editor => Editor}/CoreAPI/Delay.cs | 0 .../Editor => Editor}/CoreAPI/Delay.cs.meta | 0 .../Editor => Editor}/CoreAPI/DeployerBase.cs | 0 .../CoreAPI/DeployerBase.cs.meta | 0 .../CoreAPI/DeploymentInfo.cs | 0 .../CoreAPI/DeploymentInfo.cs.meta | 0 .../CoreAPI/DeploymentRequestFactory.cs | 0 .../CoreAPI/DeploymentRequestFactory.cs.meta | 0 .../CoreAPI/DeploymentWaiter.cs | 0 .../CoreAPI/DeploymentWaiter.cs.meta | 0 .../Editor => Editor}/CoreAPI/ErrorCode.cs | 0 .../CoreAPI/ErrorCode.cs.meta | 0 .../CoreAPI/IResponsePoller.cs | 0 .../CoreAPI/IResponsePoller.cs.meta | 0 .../Editor => Editor}/CoreAPI/Models.meta | 0 .../CoreAPI/Models/ConfirmChangesRequest.cs | 0 .../Models/ConfirmChangesRequest.cs.meta | 0 .../CoreAPI/Models/DeploymentId.cs | 0 .../CoreAPI/Models/DeploymentId.cs.meta | 0 .../CoreAPI/Models/DeploymentRequest.cs | 0 .../CoreAPI/Models/DeploymentRequest.cs.meta | 0 .../CoreAPI/Models/DeploymentResponse.cs | 0 .../CoreAPI/Models/DeploymentResponse.cs.meta | 0 .../CoreAPI/Models/FileReadAllTextResponse.cs | 0 .../Models/FileReadAllTextResponse.cs.meta | 0 .../Models/GetBootstrapDataResponse.cs | 0 .../Models/GetBootstrapDataResponse.cs.meta | 0 .../CoreAPI/Models/SaveParametersResponse.cs | 0 .../Models/SaveParametersResponse.cs.meta | 0 .../Editor => Editor}/CoreAPI/Paths.cs | 2 +- .../Editor => Editor}/CoreAPI/Paths.cs.meta | 0 .../CoreAPI/ScenarioParameter.cs | 0 .../CoreAPI/ScenarioParameter.cs.meta | 0 .../CoreAPI/ScenarioParameterKeys.cs | 0 .../CoreAPI/ScenarioParameterKeys.cs.meta | 0 .../CoreAPI/ScenarioParametersEditor.cs | 0 .../CoreAPI/ScenarioParametersEditor.cs.meta | 0 .../Editor => Editor}/CoreAPI/SettingsKeys.cs | 0 .../CoreAPI/SettingsKeys.cs.meta | 0 .../CoreAPI/StackOutputKeys.cs | 0 .../CoreAPI/StackOutputKeys.cs.meta | 0 .../Editor => Editor}/CoreAPI/StackStatus.cs | 0 .../CoreAPI/StackStatus.cs.meta | 0 .../CoreAPI/UntilResponseFailurePoller.cs | 0 .../UntilResponseFailurePoller.cs.meta | 0 .../Editor => Editor}/Credentials.meta | 0 .../Credentials/AwsCredentials.cs | 0 .../Credentials/AwsCredentials.cs.meta | 0 .../Credentials/AwsCredentialsCreation.cs | 0 .../AwsCredentialsCreation.cs.meta | 0 .../AwsCredentialsCreationPanel.cs | 0 .../AwsCredentialsCreationPanel.cs.meta | 0 .../Credentials/AwsCredentialsFactory.cs | 0 .../Credentials/AwsCredentialsFactory.cs.meta | 0 .../Credentials/AwsCredentialsUpdate.cs | 0 .../Credentials/AwsCredentialsUpdate.cs.meta | 0 .../Credentials/AwsCredentialsUpdatePanel.cs | 0 .../AwsCredentialsUpdatePanel.cs.meta | 0 .../Credentials/AwsCredentialsWindow.cs | 0 .../Credentials/AwsCredentialsWindow.cs.meta | 0 .../Credentials/PasswordDrawer.cs | 0 .../Credentials/PasswordDrawer.cs.meta | 0 .../Editor => Editor}/Credentials/Strings.cs | 0 .../Credentials/Strings.cs.meta | 0 .../Editor => Editor}/Deployment.meta | 0 .../Deployment/ChangeSetUrlFormatter.cs | 0 .../Deployment/ChangeSetUrlFormatter.cs.meta | 0 .../Deployment/DelayedOperation.cs | 0 .../Deployment/DelayedOperation.cs.meta | 0 .../Deployment/DeploymentIdContainer.cs | 0 .../Deployment/DeploymentIdContainer.cs.meta | 0 .../DeploymentIdContainerFactory.cs | 0 .../DeploymentIdContainerFactory.cs.meta | 0 .../Deployment/DeploymentSettings.cs | 0 .../Deployment/DeploymentSettings.cs.meta | 0 .../Deployment/DeploymentSettingsFactory.cs | 0 .../DeploymentSettingsFactory.cs.meta | 0 .../Deployment/DeploymentStackInfo.cs | 0 .../Deployment/DeploymentStackInfo.cs.meta | 0 .../Deployment/DeploymentStackInfoFactory.cs | 0 .../DeploymentStackInfoFactory.cs.meta | 0 .../Deployment/DeploymentWindow.cs | 0 .../Deployment/DeploymentWindow.cs.meta | 0 .../Deployment/IDeploymentIdContainer.cs | 0 .../Deployment/IDeploymentIdContainer.cs.meta | 0 .../Deployment/PathConverter.cs | 0 .../Deployment/PathConverter.cs.meta | 0 .../Deployment/ScenarioLocator.cs | 0 .../Deployment/ScenarioLocator.cs.meta | 0 .../Deployment/ScenarioParametersUpdater.cs | 0 .../ScenarioParametersUpdater.cs.meta | 0 .../Deployment/StackUpdateDialog.cs | 0 .../Deployment/StackUpdateDialog.cs.meta | 0 .../Deployment/StackUpdateModel.cs | 0 .../Deployment/StackUpdateModel.cs.meta | 0 .../Deployment/StackUpdateModelFactory.cs | 0 .../StackUpdateModelFactory.cs.meta | 0 .../Editor => Editor}/DevStrings.cs | 0 .../Editor => Editor}/DevStrings.cs.meta | 0 .../Editor => Editor}/EditorMenu.cs | 0 .../Editor => Editor}/EditorMenu.cs.meta | 0 .../EditorWindowExtensions.cs | 0 .../EditorWindowExtensions.cs.meta | 0 .../GameLiftClientSettingsEditor.cs | 0 .../GameLiftClientSettingsEditor.cs.meta | 0 .../Editor => Editor}/HyperLinkButton.cs | 0 .../Editor => Editor}/HyperLinkButton.cs.meta | 0 .../Editor => Editor}/ILogger.cs | 0 .../Editor => Editor}/ILogger.cs.meta | 0 .../Editor => Editor}/IReadStatus.cs | 0 .../Editor => Editor}/IReadStatus.cs.meta | 0 .../Editor => Editor}/ImageLoader.cs | 0 .../Editor => Editor}/ImageLoader.cs.meta | 0 .../Editor => Editor}/LocalTest.meta | 0 .../Editor => Editor}/LocalTest/LocalTest.cs | 0 .../LocalTest/LocalTest.cs.meta | 0 .../LocalTest/LocalTestFactory.cs | 0 .../LocalTest/LocalTestFactory.cs.meta | 0 .../LocalTest/LocalTestWindow.cs | 0 .../LocalTest/LocalTestWindow.cs.meta | 0 .../LocalTest/SettingsFormatter.cs | 0 .../LocalTest/SettingsFormatter.cs.meta | 0 .../Editor => Editor}/PluginSettings.meta | 0 .../PluginSettings/BootstrapSetting.cs | 0 .../PluginSettings/BootstrapSetting.cs.meta | 0 .../PluginSettings/CredentialsSetting.cs | 0 .../PluginSettings/CredentialsSetting.cs.meta | 0 .../PluginSettings/DotNetSetting.cs | 0 .../PluginSettings/DotNetSetting.cs.meta | 0 .../FirstTimeSettingsLauncher.cs | 0 .../FirstTimeSettingsLauncher.cs.meta | 0 .../PluginSettings/GameLiftLocalSetting.cs | 0 .../GameLiftLocalSetting.cs.meta | 0 .../PluginSettings/GameLiftSettingPanel.cs | 0 .../GameLiftSettingPanel.cs.meta | 0 .../PluginSettings/JavaSetting.cs | 0 .../PluginSettings/JavaSetting.cs.meta | 0 .../PluginSettings/Setting.cs | 0 .../PluginSettings/Setting.cs.meta | 0 .../PluginSettings/SettingPanel.cs | 0 .../PluginSettings/SettingPanel.cs.meta | 0 .../PluginSettings/Settings.cs | 0 .../PluginSettings/Settings.cs.meta | 0 .../PluginSettings/SettingsChecker.cs | 0 .../PluginSettings/SettingsChecker.cs.meta | 0 .../PluginSettings/SettingsState.cs | 0 .../PluginSettings/SettingsState.cs.meta | 0 .../PluginSettings/SettingsWindow.cs | 0 .../PluginSettings/SettingsWindow.cs.meta | 0 .../Editor => Editor}/ResourceUtility.cs | 0 .../Editor => Editor}/ResourceUtility.cs.meta | 0 .../Editor => Editor}/Resources.meta | 0 .../Resources/CloudFormation.meta | 0 .../Resources/CloudFormation/README.md | 0 .../Resources/CloudFormation/README.md.meta | 0 .../Resources/CloudFormation/common.meta | 0 .../CloudFormation/common/tests.meta | 0 .../CloudFormation/common/tests/loadtest.yml | 0 .../common/tests/loadtest.yml.meta | 0 .../CloudFormation/scenario1_auth_only.meta | 0 .../AmazonGameLiftPlugin.AuthOnly.asmdef | 19 + .../AmazonGameLiftPlugin.AuthOnly.asmdef.meta | 0 .../scenario1_auth_only/Deployer.cs | 0 .../scenario1_auth_only/Deployer.cs.meta | 0 .../scenario1_auth_only/cloudformation.yml | 0 .../cloudformation.yml.meta | 0 .../scenario1_auth_only/lambda.meta | 0 .../lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../scenario1_auth_only/parameters.json | 0 .../scenario1_auth_only/parameters.json.meta | 0 .../scenario1_auth_only/tests.meta | 0 .../scenario1_auth_only/tests/test.py | 0 .../scenario1_auth_only/tests/test.py.meta | 0 .../scenario2_single_fleet.meta | 0 .../AmazonGameLiftPlugin.SingleFleet.asmdef | 19 + ...azonGameLiftPlugin.SingleFleet.asmdef.meta | 0 .../scenario2_single_fleet/Deployer.cs | 0 .../scenario2_single_fleet/Deployer.cs.meta | 0 .../scenario2_single_fleet/cloudformation.yml | 0 .../cloudformation.yml.meta | 0 .../scenario2_single_fleet/lambda.meta | 0 .../lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../scenario2_single_fleet/parameters.json | 0 .../parameters.json.meta | 0 .../scenario2_single_fleet/tests.meta | 0 .../scenario2_single_fleet/tests/test.py | 0 .../scenario2_single_fleet/tests/test.py.meta | 0 .../CloudFormation/scenario3_mrf_queue.meta | 0 .../AmazonGameLiftPlugin.MrfQueue.asmdef | 19 + .../AmazonGameLiftPlugin.MrfQueue.asmdef.meta | 0 .../scenario3_mrf_queue/Deployer.cs | 0 .../scenario3_mrf_queue/Deployer.cs.meta | 0 .../scenario3_mrf_queue/cloudformation.yml | 0 .../cloudformation.yml.meta | 0 .../scenario3_mrf_queue/lambda.meta | 0 .../lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../lambda/game_session_event_handler.py | 0 .../lambda/game_session_event_handler.py.meta | 0 .../lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../lambda/simple_matchmaker.py | 0 .../lambda/simple_matchmaker.py.meta | 0 .../scenario3_mrf_queue/parameters.json | 0 .../scenario3_mrf_queue/parameters.json.meta | 0 .../scenario3_mrf_queue/tests.meta | 0 .../scenario3_mrf_queue/tests/test.py | 0 .../scenario3_mrf_queue/tests/test.py.meta | 0 .../CloudFormation/scenario4_spot_fleets.meta | 0 .../AmazonGameLiftPlugin.SpotFleets.asmdef | 19 + ...mazonGameLiftPlugin.SpotFleets.asmdef.meta | 0 .../scenario4_spot_fleets/Deployer.cs | 0 .../scenario4_spot_fleets/Deployer.cs.meta | 0 .../scenario4_spot_fleets/cloudformation.yml | 0 .../cloudformation.yml.meta | 0 .../scenario4_spot_fleets/lambda.meta | 0 .../lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../lambda/game_session_event_handler.py | 0 .../lambda/game_session_event_handler.py.meta | 0 .../lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../lambda/simple_matchmaker.py | 0 .../lambda/simple_matchmaker.py.meta | 0 .../scenario4_spot_fleets/parameters.json | 0 .../parameters.json.meta | 0 .../scenario4_spot_fleets/tests.meta | 0 .../scenario4_spot_fleets/tests/test.py | 0 .../scenario4_spot_fleets/tests/test.py.meta | 0 .../CloudFormation/scenario5_flexmatch.meta | 0 .../AmazonGameLiftPlugin.FlexMatch.asmdef | 19 + ...AmazonGameLiftPlugin.FlexMatch.asmdef.meta | 0 .../scenario5_flexmatch/Deployer.cs | 0 .../scenario5_flexmatch/Deployer.cs.meta | 0 .../scenario5_flexmatch/cloudformation.yml | 0 .../cloudformation.yml.meta | 0 .../scenario5_flexmatch/lambda.meta | 0 .../lambda/flexmatch_status_poller.py | 0 .../lambda/flexmatch_status_poller.py.meta | 0 .../lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../lambda/matchmaker_event_handler.py | 0 .../lambda/matchmaker_event_handler.py.meta | 0 .../lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../scenario5_flexmatch/parameters.json | 0 .../scenario5_flexmatch/parameters.json.meta | 0 .../scenario5_flexmatch/tests.meta | 0 .../scenario5_flexmatch/tests/test.py | 0 .../scenario5_flexmatch/tests/test.py.meta | 0 .../Editor => Editor}/Resources/Images.meta | 0 .../Resources/Images/Dark.meta | 0 .../Resources/Images/Dark}/.gitignore | 0 .../Resources/Images/Dark/GameLiftLogo.png | Bin .../Images/Dark/GameLiftLogo.png.meta | 0 .../Resources/Images/Dark/Spinner 1.png | Bin .../Resources/Images/Dark/Spinner 1.png.meta | 0 .../Resources/Images/Dark/Spinner 2.png | Bin .../Resources/Images/Dark/Spinner 2.png.meta | 0 .../Resources/Images/Dark/Spinner 3.png | Bin .../Resources/Images/Dark/Spinner 3.png.meta | 0 .../Resources/Images/Dark/Spinner 4.png | Bin .../Resources/Images/Dark/Spinner 4.png.meta | 0 .../Resources/Images/Light.meta | 0 .../Resources/Images/Light}/.gitignore | 0 .../Resources/Images/Light/GameLiftLogo.png | Bin .../Images/Light/GameLiftLogo.png.meta | 0 .../Resources/Images/Light/Spinner 1.png | Bin .../Resources/Images/Light/Spinner 1.png.meta | 0 .../Resources/Images/Light/Spinner 2.png | Bin .../Resources/Images/Light/Spinner 2.png.meta | 0 .../Resources/Images/Light/Spinner 3.png | Bin .../Resources/Images/Light/Spinner 3.png.meta | 0 .../Resources/Images/Light/Spinner 4.png | Bin .../Resources/Images/Light/Spinner 4.png.meta | 0 .../Editor => Editor}/Status.cs | 0 .../Editor => Editor}/Status.cs.meta | 0 .../Editor => Editor}/TextFilter.cs | 0 .../Editor => Editor}/TextFilter.cs.meta | 0 .../Editor => Editor}/TextProvider.cs | 0 .../Editor => Editor}/TextProvider.cs.meta | 0 .../Editor => Editor}/TextProviderFactory.cs | 0 .../TextProviderFactory.cs.meta | 0 .../Editor => Editor}/UnityLogger.cs | 0 .../Editor => Editor}/UnityLogger.cs.meta | 0 .../Editor => Editor}/UnityLoggerFactory.cs | 0 .../UnityLoggerFactory.cs.meta | 0 .../Editor => Editor}/Urls.cs | 0 .../Editor => Editor}/Urls.cs.meta | 0 .../Assets/Scripts/SampleGame.asmdef | 23 - .../Assets/Tests/UI/SampleTests.UI.asmdef | 24 - GameLift-SampleGame/Packages/manifest.json | 45 - .../ProjectSettings/AudioManager.asset | 19 - .../ProjectSettings/ClusterInputManager.asset | 6 - .../ProjectSettings/DynamicsManager.asset | 33 - .../ProjectSettings/EditorBuildSettings.asset | 14 - .../ProjectSettings/EditorSettings.asset | 23 - .../ProjectSettings/GraphicsSettings.asset | 65 - .../ProjectSettings/InputManager.asset | 295 - .../ProjectSettings/NavMeshAreas.asset | 91 - .../ProjectSettings/Physics2DSettings.asset | 56 - .../ProjectSettings/PresetManager.asset | 6 - .../ProjectSettings/ProjectSettings.asset | 612 - .../ProjectSettings/ProjectVersion.txt | 2 - .../ProjectSettings/QualitySettings.asset | 229 - .../ProjectSettings/TagManager.asset | 43 - .../ProjectSettings/TimeManager.asset | 9 - .../UnityConnectSettings.asset | 34 - .../ProjectSettings/VFXManager.asset | 11 - GameLift-Unity/.editorconfig | 263 - GameLift-Unity/.gitignore | 52 - .../AmazonGameLiftPlugin.Custom.asmdef | 18 - .../Scripts/CustomScenarioPackageExporter.cs | 32 - .../Assets/Editor/Scripts/PluginPacker.cs | 51 - .../Editor/UiTests/StackUpdateDialogTest.cs | 138 - .../Assets/com.amazonaws.gamelift.meta | 8 - .../Editor/AmazonGameLiftPlugin.Editor.asmdef | 19 - .../AmazonGameLiftPlugin.EditorCoreAPI.asmdef | 17 - .../AmazonGameLiftPlugin.AuthOnly.asmdef | 18 - .../AmazonGameLiftPlugin.SingleFleet.asmdef | 18 - .../AmazonGameLiftPlugin.MrfQueue.asmdef | 18 - .../AmazonGameLiftPlugin.SpotFleets.asmdef | 18 - .../AmazonGameLiftPlugin.FlexMatch.asmdef | 18 - .../Editor/Resources/Images/Light/.gitignore | 0 .../Plugins/AWSSDK.CloudFormation.dll.meta | 95 - .../Runtime/Plugins/AWSSDK.CloudFormation.xml | 27856 -------- .../AWSSDK.CognitoIdentityProvider.dll.meta | 95 - .../AWSSDK.CognitoIdentityProvider.xml | 41954 ------------ .../Runtime/Plugins/AWSSDK.Core.dll.meta | 95 - .../Runtime/Plugins/AWSSDK.Core.xml | 16221 ----- .../Runtime/Plugins/AWSSDK.GameLift.dll.meta | 95 - .../Runtime/Plugins/AWSSDK.GameLift.xml | 54227 ---------------- .../Runtime/Plugins/AWSSDK.S3.dll.meta | 95 - .../Runtime/Plugins/AWSSDK.S3.xml | 53714 --------------- .../Runtime/Plugins/AWSSDK.S3.xml.meta | 7 - .../Plugins/AWSSDK.SecurityToken.dll.meta | 95 - .../Runtime/Plugins/AWSSDK.SecurityToken.xml | 8940 --- .../Plugins/AWSSDK.SecurityToken.xml.meta | 7 - .../AmazonGameLiftPlugin.Core.dll.meta | 95 - .../Runtime/Plugins/GameLiftServerSDK.meta | 8 - .../GameLiftServerSDKNet45.dll.config | 3 - .../GameLiftServerSDKNet45.dll.config.meta | 92 - .../GameLiftServerSDKNet45.dll.meta | 96 - .../Google.Protobuf.dll.meta | 94 - .../GameLiftServerSDK/System.Buffers.dll.meta | 94 - .../System.Collections.Immutable.dll.meta | 94 - .../GameLiftServerSDK/System.Memory.dll.meta | 94 - ...m.Runtime.CompilerServices.Unsafe.dll.meta | 94 - .../GameLiftServerSDK/log4net.dll.meta | 94 - .../websocket-sharp.dll.meta | 94 - ...osoft.IdentityModel.JsonWebTokens.dll.meta | 95 - .../Microsoft.IdentityModel.JsonWebTokens.xml | 1023 - ...osoft.IdentityModel.JsonWebTokens.xml.meta | 7 - .../Microsoft.IdentityModel.Logging.dll.meta | 95 - .../Microsoft.IdentityModel.Logging.xml | 428 - .../Microsoft.IdentityModel.Logging.xml.meta | 7 - .../Microsoft.IdentityModel.Tokens.dll.meta | 95 - .../Microsoft.IdentityModel.Tokens.xml | 15629 ----- .../Microsoft.IdentityModel.Tokens.xml.meta | 7 - .../Plugins/Serilog.Sinks.File.dll.meta | 95 - .../Runtime/Plugins/Serilog.Sinks.File.xml | 518 - .../Plugins/Serilog.Sinks.File.xml.meta | 7 - .../Runtime/Plugins/Serilog.dll.meta | 95 - .../Runtime/Plugins/Serilog.xml | 4783 -- .../Runtime/Plugins/Serilog.xml.meta | 7 - .../System.IdentityModel.Tokens.Jwt.dll.meta | 95 - .../System.IdentityModel.Tokens.Jwt.xml | 1563 - .../System.IdentityModel.Tokens.Jwt.xml.meta | 7 - .../Runtime/Plugins/YamlDotNet.dll.meta | 95 - .../Runtime/Plugins/YamlDotNet.xml | 4936 -- .../Runtime/Plugins/YamlDotNet.xml.meta | 7 - .../Runtime/Scripts.meta | 8 - .../AmazonGameLiftPlugin.Runtime.asmdef | 17 - ...azonGameLiftPlugin.Editor.UnitTests.asmdef | 22 - .../Tests/Plugins/Castle.Core.dll.meta | 93 - .../Tests/Plugins/Castle.Core.xml | 6057 -- .../Tests/Plugins/Castle.Core.xml.meta | 7 - .../Tests/Plugins/Moq.dll.meta | 93 - .../Tests/Plugins/Moq.xml | 7815 --- .../Tests/Plugins/Moq.xml.meta | 7 - ...m.Runtime.CompilerServices.Unsafe.dll.meta | 96 - ...System.Runtime.CompilerServices.Unsafe.xml | 200 - ...m.Runtime.CompilerServices.Unsafe.xml.meta | 7 - ...System.Threading.Tasks.Extensions.dll.meta | 93 - .../System.Threading.Tasks.Extensions.xml | 166 - ...System.Threading.Tasks.Extensions.xml.meta | 7 - .../ProjectSettings/AudioManager.asset | 17 - .../ProjectSettings/ClusterInputManager.asset | 6 - .../ProjectSettings/DynamicsManager.asset | 30 - .../ProjectSettings/EditorBuildSettings.asset | 8 - .../ProjectSettings/EditorSettings.asset | 23 - .../ProjectSettings/GraphicsSettings.asset | 62 - .../ProjectSettings/InputManager.asset | 295 - .../ProjectSettings/NavMeshAreas.asset | 91 - .../ProjectSettings/NetworkManager.asset | 8 - .../ProjectSettings/Physics2DSettings.asset | 38 - .../ProjectSettings/PresetManager.asset | 27 - .../ProjectSettings/ProjectSettings.asset | 645 - .../ProjectSettings/ProjectVersion.txt | 2 - .../ProjectSettings/QualitySettings.asset | 190 - .../ProjectSettings/TagManager.asset | 43 - .../ProjectSettings/TimeManager.asset | 9 - .../UnityConnectSettings.asset | 34 - .../ProjectSettings/VFXManager.asset | 11 - .../AWSSDK.Core.xml.meta => LICENSE.md.meta | 2 +- NOTICE.md.meta | 7 + README.md | 33 +- README.md.meta | 7 + .../Runtime.meta => Runtime.meta | 0 Runtime/AmazonGameLiftPlugin.Runtime.asmdef | 19 + .../AmazonGameLiftPlugin.Runtime.asmdef.meta | 0 .../Scripts => Runtime}/AssemblyInfo.cs | 0 .../Scripts => Runtime}/AssemblyInfo.cs.meta | 0 .../Assets/Editor.meta => Runtime/Core.meta | 2 +- .../Core/AccountManagement.meta | 2 +- .../Core}/AccountManagement/AccountManager.cs | 0 .../AccountManagement/AccountManager.cs.meta | 2 +- ...AmazonSecurityTokenServiceClientWrapper.cs | 0 ...nSecurityTokenServiceClientWrapper.cs.meta | 2 +- .../AccountManagement/IAccountManager.cs | 0 .../AccountManagement/IAccountManager.cs.meta | 2 +- ...AmazonSecurityTokenServiceClientWrapper.cs | 0 ...nSecurityTokenServiceClientWrapper.cs.meta | 11 + .../Core/AccountManagement/Models.meta | 2 +- .../RetrieveAccountIdByCredentialsRequest.cs | 0 ...rieveAccountIdByCredentialsRequest.cs.meta | 11 + Runtime/Core/AmazonGameLiftPlugin.Core.csproj | 41 + .../AmazonGameLiftPlugin.Core.csproj.meta | 7 + .../AmazonGameLiftPlugin.Runtime.Core.asmdef | 16 + ...zonGameLiftPlugin.Runtime.Core.asmdef.meta | 2 +- .../Core/ApiGatewayManagement.meta | 2 +- .../AmazonGameLiftClientWrapper.cs | 0 .../AmazonGameLiftClientWrapper.cs.meta | 11 + .../Core}/ApiGatewayManagement/ApiGateway.cs | 0 .../ApiGatewayManagement/ApiGateway.cs.meta | 11 + .../ApiGatewayManagement/HttpClientWrapper.cs | 0 .../HttpClientWrapper.cs.meta | 11 + .../IAmazonGameLiftClientWrapper.cs | 0 .../IAmazonGameLiftClientWrapper.cs.meta | 11 + .../IGameServerAdapter.cs | 0 .../IGameServerAdapter.cs.meta | 11 + .../IHttpClientWrapper.cs | 0 .../IHttpClientWrapper.cs.meta | 11 + .../IJwtTokenExpirationCheck.cs | 0 .../IJwtTokenExpirationCheck.cs.meta | 11 + .../JwtTokenExpirationCheck.cs | 0 .../JwtTokenExpirationCheck.cs.meta | 11 + .../ApiGatewayManagement/LocalGameAdapter.cs | 0 .../LocalGameAdapter.cs.meta | 11 + Runtime/Core/ApiGatewayManagement/Models.meta | 8 + .../Models/ApiGatewayRequest.cs | 0 .../Models/ApiGatewayRequest.cs.meta | 11 + .../Models/GetGameConnection.cs | 0 .../Models/GetGameConnection.cs.meta | 11 + .../Models/GetGameConnectionResult.cs | 0 .../Models/GetGameConnectionResult.cs.meta | 11 + .../ApiGatewayManagement/Models/StartGame.cs | 0 .../Models/StartGame.cs.meta | 11 + Runtime/Core/BucketManagement.meta | 8 + .../Core}/BucketManagement/BucketStore.cs | 0 .../Core/BucketManagement/BucketStore.cs.meta | 11 + .../Core}/BucketManagement/IBucketStore.cs | 0 .../BucketManagement/IBucketStore.cs.meta | 11 + Runtime/Core/BucketManagement/Models.meta | 8 + .../BucketManagement/Models/BucketPolicy.cs | 0 .../Models/BucketPolicy.cs.meta | 11 + .../BucketManagement/Models/CreateBucket.cs | 0 .../Models/CreateBucket.cs.meta | 11 + .../Models/GetAvailableRegions.cs | 0 .../Models/GetAvailableRegions.cs.meta | 11 + .../Models/GetBucketPolicies.cs | 0 .../Models/GetBucketPolicies.cs.meta | 11 + .../BucketManagement/Models/GetBuckets.cs | 0 .../Models/GetBuckets.cs.meta | 11 + .../Models/PutLifecycleConfiguration.cs | 0 .../Models/PutLifecycleConfiguration.cs.meta | 11 + Runtime/Core/CredentialManagement.meta | 8 + .../CredentialManagement/CredentialsStore.cs | 0 .../CredentialsStore.cs.meta | 11 + .../CredentialManagement/ICredentialsStore.cs | 0 .../ICredentialsStore.cs.meta | 11 + Runtime/Core/CredentialManagement/Models.meta | 8 + .../Models/GetProfiles.cs | 0 .../Models/GetProfiles.cs.meta | 11 + .../Models/RetriveAwsCredentials.cs | 0 .../Models/RetriveAwsCredentials.cs.meta | 11 + .../Models/SaveAwsCredentials.cs | 0 .../Models/SaveAwsCredentials.cs.meta | 11 + .../Models/UpdateAwsCredentials.cs | 0 .../Models/UpdateAwsCredentials.cs.meta | 11 + Runtime/Core/DeploymentManagement.meta | 8 + .../AmazonCloudFormationWrapper.cs | 0 .../AmazonCloudFormationWrapper.cs.meta | 11 + .../DeploymentFormatter.cs | 0 .../DeploymentFormatter.cs.meta | 11 + .../DeploymentManagement/DeploymentManager.cs | 0 .../DeploymentManager.cs.meta | 11 + .../IAmazonCloudFormationWrapper.cs | 0 .../IAmazonCloudFormationWrapper.cs.meta | 11 + .../IDeploymentManager.cs | 0 .../IDeploymentManager.cs.meta | 11 + Runtime/Core/DeploymentManagement/Models.meta | 8 + .../Models/CancelDeployment.cs | 0 .../Models/CancelDeployment.cs.meta | 11 + .../Models/CreateChangeSet.cs | 0 .../Models/CreateChangeSet.cs.meta | 11 + .../Models/DeleteChangeSet.cs | 0 .../Models/DeleteChangeSet.cs.meta | 11 + .../Models/DeleteStack.cs | 0 .../Models/DeleteStack.cs.meta | 11 + .../Models/DescribeChangeSet.cs | 0 .../Models/DescribeChangeSet.cs.meta | 11 + .../Models/DescribeStack.cs | 0 .../Models/DescribeStack.cs.meta | 11 + .../Models/ExecuteChangeSet.cs | 0 .../Models/ExecuteChangeSet.cs.meta | 11 + .../Models/StackExists.cs | 0 .../Models/StackExists.cs.meta | 11 + .../Models/UploadServerBuild.cs | 0 .../Models/UploadServerBuild.cs.meta | 11 + .../Models/ValidateCfnTemplate.cs | 0 .../Models/ValidateCfnTemplate.cs.meta | 11 + Runtime/Core/GameLiftLocalTesting.meta | 8 + .../GameLiftLocalTesting/GameLiftProcess.cs | 0 .../GameLiftProcess.cs.meta | 11 + .../GameLiftLocalTesting/IGameLiftProcess.cs | 0 .../IGameLiftProcess.cs.meta | 11 + Runtime/Core/GameLiftLocalTesting/Models.meta | 8 + .../Models/RunLocalServer.cs | 0 .../Models/RunLocalServer.cs.meta | 11 + .../GameLiftLocalTesting/Models/Start.cs | 0 .../GameLiftLocalTesting/Models/Start.cs.meta | 11 + .../Core}/GameLiftLocalTesting/Models/Stop.cs | 0 .../GameLiftLocalTesting/Models/Stop.cs.meta | 11 + Runtime/Core/InstalledJavaVersionCheck.meta | 8 + .../IInstalledJavaVersionProvider.cs | 0 .../IInstalledJavaVersionProvider.cs.meta | 11 + .../InstalledJavaVersionProvider.cs | 0 .../InstalledJavaVersionProvider.cs.meta | 11 + .../InstalledJavaVersionCheck/Models.meta | 8 + .../CheckInstalledJavaVersionRequest.cs | 0 .../CheckInstalledJavaVersionRequest.cs.meta | 11 + Runtime/Core/Latency.meta | 8 + .../Core}/Latency/ILatencyService.cs | 0 Runtime/Core/Latency/ILatencyService.cs.meta | 11 + .../Core}/Latency/IPingWrapper.cs | 0 Runtime/Core/Latency/IPingWrapper.cs.meta | 11 + .../Core}/Latency/LatencyService.cs | 0 Runtime/Core/Latency/LatencyService.cs.meta | 11 + Runtime/Core/Latency/Models.meta | 8 + .../Core}/Latency/Models/GetLatencies.cs | 0 .../Core/Latency/Models/GetLatencies.cs.meta | 11 + .../Core}/Latency/Models/PingResult.cs | 0 .../Core/Latency/Models/PingResult.cs.meta | 11 + .../Core}/Latency/PingWrapper.cs | 0 Runtime/Core/Latency/PingWrapper.cs.meta | 11 + .../Runtime => Runtime/Core}/Plugins.meta | 2 +- .../Plugins/AWSSDK.CloudFormation.dll.meta | 33 + .../AWSSDK.CognitoIdentityProvider.dll.meta | 33 + Runtime/Core/Plugins/AWSSDK.Core.dll.meta | 33 + Runtime/Core/Plugins/AWSSDK.GameLift.dll.meta | 33 + Runtime/Core/Plugins/AWSSDK.S3.dll.meta | 33 + .../Plugins/AWSSDK.SecurityToken.dll.meta | 33 + Runtime/Core/Plugins/Castle.Core.dll.meta | 33 + ...osoft.IdentityModel.JsonWebTokens.dll.meta | 33 + .../Microsoft.IdentityModel.Logging.dll.meta | 33 + .../Microsoft.IdentityModel.Tokens.dll.meta | 33 + Runtime/Core/Plugins/Moq.dll.meta | 33 + .../Core/Plugins/Serilog.Sinks.File.dll.meta | 33 + Runtime/Core/Plugins/Serilog.dll.meta | 33 + .../System.IdentityModel.Tokens.Jwt.dll.meta | 33 + ...System.Threading.Tasks.Extensions.dll.meta | 33 + Runtime/Core/Plugins/YamlDotNet.dll.meta | 33 + Runtime/Core/README.md | 4 + Runtime/Core/README.md.meta | 7 + Runtime/Core/SettingsManagement.meta | 8 + .../SettingsManagement/ISettingsStore.cs | 0 .../SettingsManagement/ISettingsStore.cs.meta | 11 + Runtime/Core/SettingsManagement/Models.meta | 8 + .../SettingsManagement/Models/ClearSetting.cs | 0 .../Models/ClearSetting.cs.meta | 11 + .../SettingsManagement/Models/GetSetting.cs | 0 .../Models/GetSetting.cs.meta | 11 + .../SettingsManagement/Models/PutSetting.cs | 0 .../Models/PutSetting.cs.meta | 11 + .../Core}/SettingsManagement/SettingsStore.cs | 0 .../SettingsManagement/SettingsStore.cs.meta | 11 + Runtime/Core/Shared.meta | 8 + .../Core}/Shared/AwsRegionMapper.cs | 0 Runtime/Core/Shared/AwsRegionMapper.cs.meta | 11 + .../Core}/Shared/Bootstrapper.cs | 0 Runtime/Core/Shared/Bootstrapper.cs.meta | 11 + .../Core}/Shared/ErrorCode.cs | 0 Runtime/Core/Shared/ErrorCode.cs.meta | 11 + Runtime/Core/Shared/FileSystem.meta | 8 + .../Core}/Shared/FileSystem/FileWrapper.cs | 0 .../Shared/FileSystem/FileWrapper.cs.meta | 11 + .../Core}/Shared/FileSystem/IFileWrapper.cs | 0 .../Shared/FileSystem/IFileWrapper.cs.meta | 11 + Runtime/Core/Shared/FileZip.meta | 8 + .../Core}/Shared/FileZip/FileZip.cs | 0 Runtime/Core/Shared/FileZip/FileZip.cs.meta | 11 + .../Core}/Shared/FileZip/IFileZip.cs | 0 Runtime/Core/Shared/FileZip/IFileZip.cs.meta | 11 + Runtime/Core/Shared/Logging.meta | 8 + .../Core}/Shared/Logging/Logger.cs | 0 Runtime/Core/Shared/Logging/Logger.cs.meta | 11 + Runtime/Core/Shared/ProcessManagement.meta | 8 + .../ExecutableNotFoundException.cs | 0 .../ExecutableNotFoundException.cs.meta | 11 + .../ProcessManagement/IProcessWrapper.cs | 0 .../ProcessManagement/IProcessWrapper.cs.meta | 11 + .../ProcessManagement/ProcessWrapper.cs | 0 .../ProcessManagement/ProcessWrapper.cs.meta | 11 + .../Core}/Shared/Response.cs | 0 Runtime/Core/Shared/Response.cs.meta | 11 + Runtime/Core/Shared/S3Bucket.meta | 8 + .../Core}/Shared/S3Bucket/AmazonS3Wrapper.cs | 0 .../Shared/S3Bucket/AmazonS3Wrapper.cs.meta | 11 + .../Core}/Shared/S3Bucket/IAmazonS3Wrapper.cs | 0 .../Shared/S3Bucket/IAmazonS3Wrapper.cs.meta | 11 + Runtime/Core/Shared/SettingsStore.meta | 8 + .../Shared/SettingsStore/IStreamWrapper.cs | 0 .../SettingsStore/IStreamWrapper.cs.meta | 11 + .../Shared/SettingsStore/YamlStreamWrapper.cs | 0 .../SettingsStore/YamlStreamWrapper.cs.meta | 11 + .../Core}/Shared/ValidationResult.cs | 0 Runtime/Core/Shared/ValidationResult.cs.meta | 11 + Runtime/Core/UserIdentityManagement.meta | 8 + .../AmazonCognitoIdentityWrapper.cs | 0 .../AmazonCognitoIdentityWrapper.cs.meta | 11 + .../IAmazonCognitoIdentityWrapper.cs | 0 .../IAmazonCognitoIdentityWrapper.cs.meta | 11 + .../UserIdentityManagement/IUserIdentity.cs | 0 .../IUserIdentity.cs.meta | 11 + .../Core/UserIdentityManagement/Models.meta | 8 + .../Models/ConfirmSignUp.cs | 0 .../Models/ConfirmSignUp.cs.meta | 9 +- .../Models/RefreshToken.cs | 0 .../Models/RefreshToken.cs.meta | 11 + .../UserIdentityManagement/Models/SignIn.cs | 0 .../Models/SignIn.cs.meta | 11 + .../UserIdentityManagement/Models/SignOut.cs | 0 .../Models/SignOut.cs.meta | 11 + .../UserIdentityManagement/Models/SignUp.cs | 0 .../Models/SignUp.cs.meta | 11 + .../UserIdentityManagement/UserIdentity.cs | 0 .../UserIdentity.cs.meta | 11 + Runtime/Core/csc.rsp | 1 + Runtime/Core/csc.rsp.meta | 7 + .../GameLiftClientSettings.cs | 0 .../GameLiftClientSettings.cs.meta | 0 .../GameLiftConfiguration.cs | 0 .../GameLiftConfiguration.cs.meta | 0 .../Scripts => Runtime}/GameLiftCoreApi.cs | 0 .../GameLiftCoreApi.cs.meta | 0 .../Tests => Runtime}/Plugins.meta | 2 +- .../Plugins/GameLiftServerSDKNet45.dll.config | 3 + .../GameLiftServerSDKNet45.dll.config.meta | 32 + .../Plugins/GameLiftServerSDKNet45.dll.meta | 33 + Runtime/Plugins/Google.Protobuf.dll.meta | 33 + Runtime/Plugins/Google.Protobuf.pdb | Bin 0 -> 138644 bytes Runtime/Plugins/Google.Protobuf.pdb.meta | 7 + .../Plugins}/Google.Protobuf.xml | 0 .../Plugins}/Google.Protobuf.xml.meta | 2 +- Runtime/Plugins/System.Buffers.dll.meta | 33 + .../Plugins}/System.Buffers.xml | 0 .../Plugins}/System.Buffers.xml.meta | 2 +- .../System.Collections.Immutable.dll.meta | 33 + .../Plugins}/System.Collections.Immutable.xml | 0 .../System.Collections.Immutable.xml.meta | 2 +- Runtime/Plugins/System.Memory.dll.meta | 33 + .../Plugins}/System.Memory.xml | 0 .../Plugins}/System.Memory.xml.meta | 2 +- ...m.Runtime.CompilerServices.Unsafe.dll.meta | 33 + ...System.Runtime.CompilerServices.Unsafe.xml | 0 ...m.Runtime.CompilerServices.Unsafe.xml.meta | 2 +- Runtime/Plugins/log4net.dll.meta | 33 + .../Plugins}/log4net.xml | 0 .../Plugins}/log4net.xml.meta | 2 +- Runtime/Plugins/websocket-sharp.dll.meta | 33 + .../AmazonGameLiftPlugin.Custom.asmdef | 19 + .../AmazonGameLiftPlugin.Custom.asmdef.meta | 0 .../CustomScenario}/Deployer.cs | 0 .../CustomScenario}/Deployer.cs.meta | 0 .../CustomScenario}/cloudformation.yml | 0 .../CustomScenario}/cloudformation.yml.meta | 0 .../CustomScenario}/lambda.meta | 0 .../CustomScenario}/lambda/game_request.py | 0 .../lambda/game_request.py.meta | 0 .../CustomScenario}/lambda/results_request.py | 0 .../lambda/results_request.py.meta | 0 .../CustomScenario}/parameters.json | 0 .../CustomScenario}/parameters.json.meta | 0 .../SampleGame}/.editorconfig | 0 .../SampleGame}/.gitignore | 0 .../SampleGame}/Assets/Animations.meta | 0 .../Spinner Animator Controller.controller | 0 ...pinner Animator Controller.controller.meta | 0 .../Assets/Animations/Spinner Rotate.anim | 0 .../Animations/Spinner Rotate.anim.meta | 0 .../SampleGame}/Assets/Editor.meta | 0 .../SampleGame}/Assets/Editor/Scripts.meta | 0 .../Editor/Scripts/ClientServerSwitchMenu.cs | 0 .../Scripts/ClientServerSwitchMenu.cs.meta | 0 .../Scripts/GameLiftClientSettingsMenu.cs | 0 .../GameLiftClientSettingsMenu.cs.meta | 0 .../Editor/Scripts/UnityPackageExporter.cs | 17 +- .../Scripts/UnityPackageExporter.cs.meta | 0 .../SampleGame}/Assets/Prefabs.meta | 0 .../Prefabs/ConfirmationCodeScreen.prefab | 0 .../ConfirmationCodeScreen.prefab.meta | 0 .../Prefabs/ConfirmationSuccessScreen.prefab | 0 .../ConfirmationSuccessScreen.prefab.meta | 0 .../Assets/Prefabs/GameLiftStatic.prefab | 0 .../Assets/Prefabs/GameLiftStatic.prefab.meta | 0 .../Assets/Prefabs/InputField.prefab | 0 .../Assets/Prefabs/InputField.prefab.meta | 0 .../Assets/Prefabs/QuitCanvasStatic.prefab | 0 .../Prefabs/QuitCanvasStatic.prefab.meta | 0 .../Assets/Prefabs/SignInScreen.prefab | 0 .../Assets/Prefabs/SignInScreen.prefab.meta | 0 .../Assets/Prefabs/SignUpScreen.prefab | 0 .../Assets/Prefabs/SignUpScreen.prefab.meta | 0 .../SampleGame}/Assets/Prefabs/Spinner.prefab | 0 .../Assets/Prefabs/Spinner.prefab.meta | 0 .../Assets/Prefabs/StartGameScreen.prefab | 0 .../Prefabs/StartGameScreen.prefab.meta | 0 .../Assets/Prefabs/SubmitButton.prefab | 0 .../Assets/Prefabs/SubmitButton.prefab.meta | 0 .../SampleGame}/Assets/Resources.meta | 0 .../Assets/Resources/Materials.meta | 0 .../Assets/Resources/Materials/Color001.mat | 0 .../Resources/Materials/Color001.mat.meta | 0 .../Assets/Resources/Materials/Color002.mat | 0 .../Resources/Materials/Color002.mat.meta | 0 .../Assets/Resources/Materials/Color003.mat | 0 .../Resources/Materials/Color003.mat.meta | 0 .../Assets/Resources/Materials/Color004.mat | 0 .../Resources/Materials/Color004.mat.meta | 0 .../Assets/Resources/Materials/Color005.mat | 0 .../Resources/Materials/Color005.mat.meta | 0 .../Assets/Resources/Materials/Color006.mat | 0 .../Resources/Materials/Color006.mat.meta | 0 .../Assets/Resources/Materials/Color007.mat | 0 .../Resources/Materials/Color007.mat.meta | 0 .../Assets/Resources/Materials/Color008.mat | 0 .../Resources/Materials/Color008.mat.meta | 0 .../SampleGame}/Assets/Scenes.meta | 0 .../Assets/Scenes/BootstrapScene.unity | 0 .../Assets/Scenes/BootstrapScene.unity.meta | 0 .../SampleGame}/Assets/Scenes/GameScene.unity | 0 .../Assets/Scenes/GameScene.unity.meta | 0 .../SampleGame}/Assets/Scripts.meta | 0 .../SampleGame}/Assets/Scripts/Chord.cs | 0 .../SampleGame}/Assets/Scripts/Chord.cs.meta | 0 .../SampleGame}/Assets/Scripts/Client.meta | 0 .../Scripts/Client/ClientCredentials.cs | 0 .../Scripts/Client/ClientCredentials.cs.meta | 0 .../Assets/Scripts/Client/Delay.cs | 0 .../Assets/Scripts/Client/Delay.cs.meta | 0 .../Assets/Scripts/Client/GameLiftClient.cs | 0 .../Scripts/Client/GameLiftClient.cs.meta | 0 .../Scripts/Client/LoggingGameLiftCoreApi.cs | 0 .../Client/LoggingGameLiftCoreApi.cs.meta | 0 .../Assets/Scripts/Client/NetworkClient.cs | 0 .../Scripts/Client/NetworkClient.cs.meta | 0 .../Assets/Scripts/ClientBootstrap.cs | 0 .../Assets/Scripts/ClientBootstrap.cs.meta | 0 .../SampleGame}/Assets/Scripts/GameLift.cs | 0 .../Assets/Scripts/GameLift.cs.meta | 0 .../SampleGame}/Assets/Scripts/GameLog.cs | 0 .../Assets/Scripts/GameLog.cs.meta | 0 .../SampleGame}/Assets/Scripts/GameLogic.cs | 0 .../Assets/Scripts/GameLogic.cs.meta | 0 .../SampleGame}/Assets/Scripts/Global.cs | 0 .../SampleGame}/Assets/Scripts/Global.cs.meta | 0 .../SampleGame}/Assets/Scripts/Input.cs | 0 .../SampleGame}/Assets/Scripts/Input.cs.meta | 0 .../SampleGame}/Assets/Scripts/Logger.cs | 0 .../SampleGame}/Assets/Scripts/Logger.cs.meta | 0 .../Assets/Scripts/NetworkProtocol.cs | 0 .../Assets/Scripts/NetworkProtocol.cs.meta | 0 .../SampleGame}/Assets/Scripts/QuitGame.cs | 0 .../Assets/Scripts/QuitGame.cs.meta | 0 .../SampleGame}/Assets/Scripts/Render.cs | 0 .../SampleGame}/Assets/Scripts/Render.cs.meta | 0 .../Assets/Scripts/SampleGame.asmdef | 9 +- .../Assets/Scripts/SampleGame.asmdef.meta | 0 .../SampleGame}/Assets/Scripts/Server.meta | 0 .../Assets/Scripts/Server/GameLiftServer.cs | 0 .../Scripts/Server/GameLiftServer.cs.meta | 0 .../Assets/Scripts/Server/NetworkServer.cs | 0 .../Scripts/Server/NetworkServer.cs.meta | 0 .../Assets/Scripts/ServerBootstrap.cs | 0 .../Assets/Scripts/ServerBootstrap.cs.meta | 0 .../SampleGame}/Assets/Scripts/Simulation.cs | 0 .../Assets/Scripts/Simulation.cs.meta | 0 .../SampleGame}/Assets/Scripts/Status.cs | 0 .../SampleGame}/Assets/Scripts/Status.cs.meta | 0 .../SampleGame}/Assets/Scripts/Strings.cs | 0 .../Assets/Scripts/Strings.cs.meta | 0 .../SampleGame}/Assets/Scripts/UI.meta | 0 .../Assets/Scripts/UI/ClientSettingsView.cs | 0 .../Scripts/UI/ClientSettingsView.cs.meta | 0 .../Scripts/UI/ConfirmationCodeScreen.cs | 0 .../Scripts/UI/ConfirmationCodeScreen.cs.meta | 0 .../Scripts/UI/ConfirmationSuccessScreen.cs | 0 .../UI/ConfirmationSuccessScreen.cs.meta | 0 .../Assets/Scripts/UI/FormScreen.cs | 0 .../Assets/Scripts/UI/FormScreen.cs.meta | 0 .../Assets/Scripts/UI/GameScreen.cs | 0 .../Assets/Scripts/UI/GameScreen.cs.meta | 0 .../Assets/Scripts/UI/SignInScreen.cs | 0 .../Assets/Scripts/UI/SignInScreen.cs.meta | 0 .../Assets/Scripts/UI/SignUpScreen.cs | 0 .../Assets/Scripts/UI/SignUpScreen.cs.meta | 0 .../Assets/Scripts/UI/StartGameScreen.cs | 0 .../Assets/Scripts/UI/StartGameScreen.cs.meta | 0 .../SampleGame}/Assets/Settings.meta | 0 .../Settings/GameLiftClientSettings.asset | 0 .../GameLiftClientSettings.asset.meta | 0 .../SampleGame}/Assets/Sprites.meta | 0 .../SampleGame}/Assets/Sprites/UI.meta | 0 .../Assets/Sprites/UI/Spinner.meta | 0 .../Assets/Sprites/UI/Spinner/Spinner 1.png | Bin .../Sprites/UI/Spinner/Spinner 1.png.meta | 0 .../Assets/Sprites/UI/Spinner/Spinner 2.png | Bin .../Sprites/UI/Spinner/Spinner 2.png.meta | 0 .../Assets/Sprites/UI/Spinner/Spinner 3.png | Bin .../Sprites/UI/Spinner/Spinner 3.png.meta | 0 .../Assets/Sprites/UI/Spinner/Spinner 4.png | Bin .../Sprites/UI/Spinner/Spinner 4.png.meta | 0 .../SampleGame}/Assets/Tests.meta | 0 .../SampleGame}/Assets/Tests/Editor.meta | 0 .../SampleGame}/Assets/Tests/Editor/Unit.meta | 0 .../Assets/Tests/Editor/Unit/AssertAsync.cs | 0 .../Tests/Editor/Unit/AssertAsync.cs.meta | 0 .../Editor/Unit/CoroutineTaskExtensions.cs | 0 .../Unit/CoroutineTaskExtensions.cs.meta | 0 .../Tests/Editor/Unit/GameLiftClientTests.cs | 0 .../Editor/Unit/GameLiftClientTests.cs.meta | 0 .../Tests/Editor/Unit/SampleTests.Unit.asmdef | 8 +- .../Editor/Unit/SampleTests.Unit.asmdef.meta | 0 .../SampleGame}/Assets/Tests/UI.meta | 0 .../SampleGame}/Assets/Tests/UI/AssetPaths.cs | 0 .../Assets/Tests/UI/AssetPaths.cs.meta | 0 .../Assets/Tests/UI/AwsTestIdentity.cs | 0 .../Assets/Tests/UI/AwsTestIdentity.cs.meta | 0 .../UI/GameLiftClientSettingsOverride.cs | 0 .../UI/GameLiftClientSettingsOverride.cs.meta | 0 .../Assets/Tests/UI/GameObjectNames.cs | 0 .../Assets/Tests/UI/GameObjectNames.cs.meta | 0 .../Assets/Tests/UI/PlayModeUtility.cs | 0 .../Assets/Tests/UI/PlayModeUtility.cs.meta | 0 .../Assets/Tests/UI/SampleTests.UI.asmdef | 29 + .../Tests/UI/SampleTests.UI.asmdef.meta | 0 .../Assets/Tests/UI/SignInTests.cs | 0 .../Assets/Tests/UI/SignInTests.cs.meta | 0 .../Tests/UI/SignUpTestGameLiftCoreApi.cs | 0 .../UI/SignUpTestGameLiftCoreApi.cs.meta | 0 .../Assets/Tests/UI/SignUpTests.cs | 0 .../Assets/Tests/UI/SignUpTests.cs.meta | 0 .../Assets/Tests/UI/StartGameTests.cs | 0 .../Assets/Tests/UI/StartGameTests.cs.meta | 0 .../SampleGame}/Assets/Tests/UI/TestInput.cs | 0 .../Assets/Tests/UI/TestInput.cs.meta | 0 .../Assets/Tests/UI/TestSettings.cs | 0 .../Assets/Tests/UI/TestSettings.cs.meta | 0 .../Assets/Tests/UI/TestSettingsSource.cs | 0 .../Tests/UI/TestSettingsSource.cs.meta | 0 .../Assets/Tests/UI/WaitForGameObjectFound.cs | 0 .../Tests/UI/WaitForGameObjectFound.cs.meta | 0 .../Assets/Tests/UI/WaitForSceneLoaded.cs | 0 .../Tests/UI/WaitForSceneLoaded.cs.meta | 0 .../Assets/Tests/UI/WaitUnitilCondition.cs | 0 .../Tests/UI/WaitUnitilCondition.cs.meta | 0 .../Assets/Tests/UI/WaitWithTimeOut.cs | 0 .../Assets/Tests/UI/WaitWithTimeOut.cs.meta | 0 .../SampleGame}/Packages/manifest.json | 2 +- .../SampleGame}/README.md | 0 .../SampleGame}/README.md.meta | 0 .../SampleGame}/UiTestSettings.json | 0 Scripts~/windows/.build-core-library.ps1 | 22 + .../windows/.build-gamelift-server-sdk.ps1 | 69 + Scripts~/windows/.build-sample-game.ps1 | 44 + Scripts~/windows/.clean-builds.ps1 | 44 + Scripts~/windows/.clean-download-files.ps1 | 36 + Scripts~/windows/.clean-exports.ps1 | 22 + Scripts~/windows/build.ps1 | 3 + Scripts~/windows/clean.ps1 | 3 + Scripts~/windows/export.ps1 | 18 + Scripts~/windows/release.ps1 | 3 + .../Tests.meta => Tests.meta | 0 .../Tests => Tests}/Editor.meta | 0 ...azonGameLiftPlugin.Editor.UnitTests.asmdef | 25 + ...ameLiftPlugin.Editor.UnitTests.asmdef.meta | 0 .../Unit => Tests/Editor}/AssemblyInfo.cs | 0 .../Editor}/AssemblyInfo.cs.meta | 0 .../Unit => Tests/Editor}/AssertAsync.cs | 0 .../Unit => Tests/Editor}/AssertAsync.cs.meta | 0 .../Editor}/AwsCredentialsCreationTests.cs | 0 .../AwsCredentialsCreationTests.cs.meta | 0 .../Editor}/AwsCredentialsTests.cs | 0 .../Editor}/AwsCredentialsTests.cs.meta | 0 .../Editor}/AwsCredentialsUpdateTests.cs | 0 .../Editor}/AwsCredentialsUpdateTests.cs.meta | 0 .../Unit => Tests/Editor}/Bootstrap.meta | 0 .../BootstrapBucketFormatterTests.cs | 0 .../BootstrapBucketFormatterTests.cs.meta | 0 .../Bootstrap/BootstrapSettingsTests.cs | 0 .../Bootstrap/BootstrapSettingsTests.cs.meta | 0 .../Bootstrap/BootstrapUtilityTests.cs | 0 .../Bootstrap/BootstrapUtilityTests.cs.meta | 0 .../Bootstrap/BucketUrlFormatterTests.cs | 0 .../Bootstrap/BucketUrlFormatterTests.cs.meta | 0 .../Editor}/CoreApiMockExtensions.cs | 0 .../Editor}/CoreApiMockExtensions.cs.meta | 0 .../Editor}/CoroutineTaskExtensions.cs | 0 .../Editor}/CoroutineTaskExtensions.cs.meta | 0 .../Unit => Tests/Editor}/Deployment.meta | 0 .../Editor}/Deployment/DeployerTests.cs | 0 .../Editor}/Deployment/DeployerTests.cs.meta | 0 .../DeploymentRequestFactoryTests.cs | 0 .../DeploymentRequestFactoryTests.cs.meta | 0 .../Deployment/DeploymentSettingsTests.cs | 0 .../DeploymentSettingsTests.cs.meta | 0 .../Deployment/DeploymentWaiterTests.cs | 0 .../Deployment/DeploymentWaiterTests.cs.meta | 0 .../ScenarioParametersUpdaterTests.cs | 0 .../ScenarioParametersUpdaterTests.cs.meta | 0 .../Editor}/Deployment/TestedDeployer.cs | 0 .../Editor}/Deployment/TestedDeployer.cs.meta | 0 .../UntilResponseFailurePollerTests.cs | 0 .../UntilResponseFailurePollerTests.cs.meta | 0 .../Unit => Tests/Editor}/ImageLoaderTests.cs | 0 .../Editor}/ImageLoaderTests.cs.meta | 0 .../Unit => Tests/Editor}/LocalTest.meta | 0 .../Editor}/LocalTest/LocalTestTests.cs | 0 .../Editor}/LocalTest/LocalTestTests.cs.meta | 0 .../Unit => Tests/Editor}/MockLogger.cs | 0 .../Unit => Tests/Editor}/MockLogger.cs.meta | 0 .../Unit => Tests/Editor}/PluginSettings.meta | 0 .../PluginSettings/BootstrapSettingTests.cs | 0 .../BootstrapSettingTests.cs.meta | 0 .../PluginSettings/CredentialsSettingTests.cs | 0 .../CredentialsSettingTests.cs.meta | 0 .../PluginSettings/JavaSettingTests.cs | 0 .../PluginSettings/JavaSettingTests.cs.meta | 0 .../Editor}/RegionBootstrapTests.cs | 0 .../Editor}/RegionBootstrapTests.cs.meta | 0 .../Unit => Tests/Editor}/StatusTests.cs | 0 .../Unit => Tests/Editor}/StatusTests.cs.meta | 0 .../Editor}/TextProviderTests.cs | 0 .../Editor}/TextProviderTests.cs.meta | 0 Tests/Runtime.meta | 8 + Tests/Runtime/Core.meta | 8 + Tests/Runtime/Core/AccountManagement.meta | 8 + .../AccountManagement/AccountManagerTests.cs | 0 .../AccountManagerTests.cs.meta | 11 + Tests/Runtime/Core/ApiGateWayManagement.meta | 8 + .../ApiGateWayManagement/ApiGatewayTests.cs | 0 .../ApiGatewayTests.cs.meta | 11 + .../LocalGameAdapterTests.cs | 0 .../LocalGameAdapterTests.cs.meta | 11 + Tests/Runtime/Core/BucketManagement.meta | 8 + .../BucketManagement/BucketStoreTests.cs | 0 .../BucketManagement/BucketStoreTests.cs.meta | 11 + Tests/Runtime/Core/CredentialManagement.meta | 8 + .../CredentialsStoreTests.cs | 0 .../CredentialsStoreTests.cs.meta | 11 + Tests/Runtime/Core/DeploymentManagement.meta | 8 + .../DeploymentManagerTests.cs | 0 .../DeploymentManagerTests.cs.meta | 11 + Tests/Runtime/Core/Factories.meta | 8 + .../Core}/Factories/BucketStoreFactory.cs | 0 .../Core/Factories/BucketStoreFactory.cs.meta | 11 + .../Factories/CredentialsStoreFactory.cs | 0 .../Factories/CredentialsStoreFactory.cs.meta | 11 + .../Core}/Factories/SettingsStoreFactory.cs | 0 .../Factories/SettingsStoreFactory.cs.meta | 11 + Tests/Runtime/Core/GameLiftLocalTesting.meta | 8 + .../GameLiftProcessTests.cs | 0 .../GameLiftProcessTests.cs.meta | 11 + .../Core/InstalledJavaVersionCheck.meta | 8 + .../InstalledJavaVersionProviderFactory.cs | 0 ...nstalledJavaVersionProviderFactory.cs.meta | 11 + .../InstalledJavaVersionProviderTests.cs | 0 .../InstalledJavaVersionProviderTests.cs.meta | 11 + Tests/Runtime/Core/Latency.meta | 8 + .../Core}/Latency/LatencyServiceTests.cs | 0 .../Core/Latency/LatencyServiceTests.cs.meta | 11 + Tests/Runtime/Core/Properties.meta | 8 + .../Runtime/Core}/Properties/AssemblyInfo.cs | 0 .../Core/Properties/AssemblyInfo.cs.meta | 11 + Tests/Runtime/Core/SettingsManagement.meta | 8 + .../SettingsManagement/SettingsStoreTests.cs | 0 .../SettingsStoreTests.cs.meta | 11 + .../Runtime/Core/UserIdentityManagement.meta | 8 + .../UserIdentityTests.cs | 0 .../UserIdentityTests.cs.meta | 11 + bin/windows/build.ps1 | 27 - bin/windows/clean.ps1 | 56 - bin/windows/setup.ps1 | 79 - .../package.json => package.json | 19 +- .../package.json.meta => package.json.meta | 0 1083 files changed, 2967 insertions(+), 253927 deletions(-) delete mode 100644 .gitattributes create mode 100644 .npmignore delete mode 100644 AmazonGameLiftPlugin.Core/.editorconfig delete mode 100644 AmazonGameLiftPlugin.Core/.gitignore delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AmazonGameLiftPlugin.Core.Tests.csproj delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/packages.config delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.sln delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.csproj delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Properties/AssemblyInfo.cs delete mode 100644 AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/packages.config rename GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml.meta => CHANGELOG.md.meta (75%) rename GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml.meta => CODE_OF_CONDUCT.md.meta (75%) rename GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml.meta => CONTRIBUTING.md.meta (75%) rename GameLift-Unity/Assets/com.amazonaws.gamelift/Editor.meta => Editor.meta (100%) create mode 100644 Editor/AmazonGameLiftPlugin.Editor.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/AmazonGameLiftPlugin.Editor.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/AssemblyInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/AssemblyInfo.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/AssetNames.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/AssetNames.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapBucketFormatter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapBucketFormatter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapSettings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapSettings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapSettingsFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapSettingsFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapWindow.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BootstrapWindow.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketLifecyclePolicyTextProvider.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketLifecyclePolicyTextProvider.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketUrlFormatter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/BucketUrlFormatter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/IBucketNameFormatter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/IBucketNameFormatter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/RegionBootstrap.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Bootstrap/RegionBootstrap.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ControlDrawer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ControlDrawer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ControlDrawerFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ControlDrawerFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/Dialog.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/Dialog.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/DialogAction.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/DialogAction.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/GuiLayoutImageSequenceDrawer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/GuiLayoutImageSequenceDrawer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ImageSequenceDrawer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/ImageSequenceDrawer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/SpinnerDrawerFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/SpinnerDrawerFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/StatusLabel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Controls/StatusLabel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI.meta (100%) create mode 100644 Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/AssemblyInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/AssemblyInfo.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/BootstrapUtility.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/BootstrapUtility.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ChangeSetExecutionStatus.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ChangeSetExecutionStatus.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ConfirmChangesDelegate.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ConfirmChangesDelegate.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/CoreApi.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/CoreApi.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Delay.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Delay.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeployerBase.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeployerBase.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentInfo.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentRequestFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentRequestFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentWaiter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/DeploymentWaiter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ErrorCode.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ErrorCode.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/IResponsePoller.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/IResponsePoller.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/ConfirmChangesRequest.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/ConfirmChangesRequest.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentId.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentId.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentRequest.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentRequest.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentResponse.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/DeploymentResponse.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/FileReadAllTextResponse.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/FileReadAllTextResponse.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/GetBootstrapDataResponse.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/GetBootstrapDataResponse.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/SaveParametersResponse.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Models/SaveParametersResponse.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Paths.cs (89%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/Paths.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParameter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParameter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParameterKeys.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParameterKeys.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParametersEditor.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/ScenarioParametersEditor.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/SettingsKeys.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/SettingsKeys.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/StackOutputKeys.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/StackOutputKeys.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/StackStatus.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/StackStatus.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/UntilResponseFailurePoller.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/CoreAPI/UntilResponseFailurePoller.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentials.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentials.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsCreation.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsCreation.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsCreationPanel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsCreationPanel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsUpdate.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsUpdate.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsUpdatePanel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsUpdatePanel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsWindow.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/AwsCredentialsWindow.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/PasswordDrawer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/PasswordDrawer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/Strings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Credentials/Strings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ChangeSetUrlFormatter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ChangeSetUrlFormatter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DelayedOperation.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DelayedOperation.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentIdContainer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentIdContainer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentIdContainerFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentIdContainerFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentSettings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentSettings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentSettingsFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentSettingsFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentStackInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentStackInfo.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentStackInfoFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentStackInfoFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentWindow.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/DeploymentWindow.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/IDeploymentIdContainer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/IDeploymentIdContainer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/PathConverter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/PathConverter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ScenarioLocator.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ScenarioLocator.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ScenarioParametersUpdater.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/ScenarioParametersUpdater.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateDialog.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateDialog.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateModel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateModel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateModelFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Deployment/StackUpdateModelFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/DevStrings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/DevStrings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/EditorMenu.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/EditorMenu.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/EditorWindowExtensions.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/EditorWindowExtensions.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/GameLiftClientSettingsEditor.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/GameLiftClientSettingsEditor.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/HyperLinkButton.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/HyperLinkButton.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ILogger.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ILogger.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/IReadStatus.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/IReadStatus.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ImageLoader.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ImageLoader.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTest.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTest.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTestFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTestFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTestWindow.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/LocalTestWindow.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/SettingsFormatter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/LocalTest/SettingsFormatter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/BootstrapSetting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/BootstrapSetting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/CredentialsSetting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/CredentialsSetting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/DotNetSetting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/DotNetSetting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/FirstTimeSettingsLauncher.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/FirstTimeSettingsLauncher.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/GameLiftLocalSetting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/GameLiftLocalSetting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/GameLiftSettingPanel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/GameLiftSettingPanel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/JavaSetting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/JavaSetting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/Setting.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/Setting.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingPanel.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingPanel.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/Settings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/Settings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsChecker.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsChecker.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsState.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsState.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsWindow.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/PluginSettings/SettingsWindow.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ResourceUtility.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/ResourceUtility.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/README.md (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/README.md.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/common.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/common/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/common/tests/loadtest.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/common/tests/loadtest.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only.meta (100%) create mode 100644 Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/Deployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/lambda.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/parameters.json (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/parameters.json.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/tests/test.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario1_auth_only/tests/test.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet.meta (100%) create mode 100644 Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/lambda.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/parameters.json (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/parameters.json.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/tests/test.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario2_single_fleet/tests/test.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue.meta (100%) create mode 100644 Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/parameters.json (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/parameters.json.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets.meta (100%) create mode 100644 Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/parameters.json (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/parameters.json.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch.meta (100%) create mode 100644 Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/parameters.json (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/parameters.json.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/tests/test.py (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/CloudFormation/scenario5_flexmatch/tests/test.py.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark.meta (100%) rename {GameLift-Unity/Assets => Editor/Resources/Images/Dark}/.gitignore (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/GameLiftLogo.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/GameLiftLogo.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 1.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 1.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 2.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 2.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 3.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 3.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 4.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Dark/Spinner 4.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark => Editor/Resources/Images/Light}/.gitignore (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/GameLiftLogo.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/GameLiftLogo.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 1.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 1.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 2.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 2.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 3.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 3.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 4.png (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Resources/Images/Light/Spinner 4.png.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Status.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Status.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextFilter.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextFilter.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextProvider.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextProvider.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextProviderFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/TextProviderFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/UnityLogger.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/UnityLogger.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/UnityLoggerFactory.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/UnityLoggerFactory.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Urls.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Editor => Editor}/Urls.cs.meta (100%) delete mode 100644 GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef delete mode 100644 GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef delete mode 100644 GameLift-SampleGame/Packages/manifest.json delete mode 100644 GameLift-SampleGame/ProjectSettings/AudioManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/ClusterInputManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/DynamicsManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/EditorBuildSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/EditorSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/GraphicsSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/InputManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/NavMeshAreas.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/Physics2DSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/PresetManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/ProjectSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/ProjectVersion.txt delete mode 100644 GameLift-SampleGame/ProjectSettings/QualitySettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/TagManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/TimeManager.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/UnityConnectSettings.asset delete mode 100644 GameLift-SampleGame/ProjectSettings/VFXManager.asset delete mode 100644 GameLift-Unity/.editorconfig delete mode 100644 GameLift-Unity/.gitignore delete mode 100644 GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef delete mode 100644 GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs delete mode 100644 GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs delete mode 100644 GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/.gitignore delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AmazonGameLiftPlugin.Core.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/websocket-sharp.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.dll.meta delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml delete mode 100644 GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml.meta delete mode 100644 GameLift-Unity/ProjectSettings/AudioManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/ClusterInputManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/DynamicsManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/EditorBuildSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/EditorSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/GraphicsSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/InputManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/NavMeshAreas.asset delete mode 100644 GameLift-Unity/ProjectSettings/NetworkManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/Physics2DSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/PresetManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/ProjectSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/ProjectVersion.txt delete mode 100644 GameLift-Unity/ProjectSettings/QualitySettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/TagManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/TimeManager.asset delete mode 100644 GameLift-Unity/ProjectSettings/UnityConnectSettings.asset delete mode 100644 GameLift-Unity/ProjectSettings/VFXManager.asset rename GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml.meta => LICENSE.md.meta (75%) create mode 100644 NOTICE.md.meta create mode 100644 README.md.meta rename GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime.meta => Runtime.meta (100%) create mode 100644 Runtime/AmazonGameLiftPlugin.Runtime.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/AmazonGameLiftPlugin.Runtime.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/AssemblyInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/AssemblyInfo.cs.meta (100%) rename GameLift-Unity/Assets/Editor.meta => Runtime/Core.meta (77%) rename GameLift-Unity/Assets/Editor/Custom Scenario.meta => Runtime/Core/AccountManagement.meta (77%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/AccountManagement/AccountManager.cs (100%) rename GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs.meta => Runtime/Core/AccountManagement/AccountManager.cs.meta (83%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs (100%) rename GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs.meta => Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs.meta (83%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/AccountManagement/IAccountManager.cs (100%) rename GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs.meta => Runtime/Core/AccountManagement/IAccountManager.cs.meta (83%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs (100%) create mode 100644 Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs.meta rename GameLift-Unity/Assets/Editor/Scripts.meta => Runtime/Core/AccountManagement/Models.meta (77%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs (100%) create mode 100644 Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs.meta create mode 100644 Runtime/Core/AmazonGameLiftPlugin.Core.csproj create mode 100644 Runtime/Core/AmazonGameLiftPlugin.Core.csproj.meta create mode 100644 Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef rename GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef.meta => Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef.meta (76%) rename GameLift-Unity/Assets/Editor/UiTests.meta => Runtime/Core/ApiGatewayManagement.meta (77%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/ApiGateway.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/ApiGateway.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/HttpClientWrapper.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/IGameServerAdapter.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/IHttpClientWrapper.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/IJwtTokenExpirationCheck.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/JwtTokenExpirationCheck.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/LocalGameAdapter.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs.meta create mode 100644 Runtime/Core/ApiGatewayManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/Models/ApiGatewayRequest.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/Models/GetGameConnection.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/Models/GetGameConnectionResult.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/ApiGatewayManagement/Models/StartGame.cs (100%) create mode 100644 Runtime/Core/ApiGatewayManagement/Models/StartGame.cs.meta create mode 100644 Runtime/Core/BucketManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/BucketStore.cs (100%) create mode 100644 Runtime/Core/BucketManagement/BucketStore.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/IBucketStore.cs (100%) create mode 100644 Runtime/Core/BucketManagement/IBucketStore.cs.meta create mode 100644 Runtime/Core/BucketManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/BucketPolicy.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/BucketPolicy.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/CreateBucket.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/CreateBucket.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/GetAvailableRegions.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/GetBucketPolicies.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/GetBuckets.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/GetBuckets.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/BucketManagement/Models/PutLifecycleConfiguration.cs (100%) create mode 100644 Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs.meta create mode 100644 Runtime/Core/CredentialManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/CredentialsStore.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/CredentialsStore.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/ICredentialsStore.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/ICredentialsStore.cs.meta create mode 100644 Runtime/Core/CredentialManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/Models/GetProfiles.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/Models/GetProfiles.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/Models/RetriveAwsCredentials.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/Models/SaveAwsCredentials.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/CredentialManagement/Models/UpdateAwsCredentials.cs (100%) create mode 100644 Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs.meta create mode 100644 Runtime/Core/DeploymentManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/AmazonCloudFormationWrapper.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/DeploymentFormatter.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/DeploymentFormatter.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/DeploymentManager.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/DeploymentManager.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/IAmazonCloudFormationWrapper.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/IDeploymentManager.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/IDeploymentManager.cs.meta create mode 100644 Runtime/Core/DeploymentManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/CancelDeployment.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/CreateChangeSet.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/DeleteChangeSet.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/DeleteStack.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/DeleteStack.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/DescribeChangeSet.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/DescribeStack.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/DescribeStack.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/ExecuteChangeSet.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/StackExists.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/StackExists.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/UploadServerBuild.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/DeploymentManagement/Models/ValidateCfnTemplate.cs (100%) create mode 100644 Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs.meta create mode 100644 Runtime/Core/GameLiftLocalTesting.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/GameLiftLocalTesting/GameLiftProcess.cs (100%) create mode 100644 Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/GameLiftLocalTesting/IGameLiftProcess.cs (100%) create mode 100644 Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs.meta create mode 100644 Runtime/Core/GameLiftLocalTesting/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/GameLiftLocalTesting/Models/RunLocalServer.cs (100%) create mode 100644 Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/GameLiftLocalTesting/Models/Start.cs (100%) create mode 100644 Runtime/Core/GameLiftLocalTesting/Models/Start.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/GameLiftLocalTesting/Models/Stop.cs (100%) create mode 100644 Runtime/Core/GameLiftLocalTesting/Models/Stop.cs.meta create mode 100644 Runtime/Core/InstalledJavaVersionCheck.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs (100%) create mode 100644 Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs (100%) create mode 100644 Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs.meta create mode 100644 Runtime/Core/InstalledJavaVersionCheck/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs (100%) create mode 100644 Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs.meta create mode 100644 Runtime/Core/Latency.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/ILatencyService.cs (100%) create mode 100644 Runtime/Core/Latency/ILatencyService.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/IPingWrapper.cs (100%) create mode 100644 Runtime/Core/Latency/IPingWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/LatencyService.cs (100%) create mode 100644 Runtime/Core/Latency/LatencyService.cs.meta create mode 100644 Runtime/Core/Latency/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/Models/GetLatencies.cs (100%) create mode 100644 Runtime/Core/Latency/Models/GetLatencies.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/Models/PingResult.cs (100%) create mode 100644 Runtime/Core/Latency/Models/PingResult.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Latency/PingWrapper.cs (100%) create mode 100644 Runtime/Core/Latency/PingWrapper.cs.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime => Runtime/Core}/Plugins.meta (77%) create mode 100644 Runtime/Core/Plugins/AWSSDK.CloudFormation.dll.meta create mode 100644 Runtime/Core/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta create mode 100644 Runtime/Core/Plugins/AWSSDK.Core.dll.meta create mode 100644 Runtime/Core/Plugins/AWSSDK.GameLift.dll.meta create mode 100644 Runtime/Core/Plugins/AWSSDK.S3.dll.meta create mode 100644 Runtime/Core/Plugins/AWSSDK.SecurityToken.dll.meta create mode 100644 Runtime/Core/Plugins/Castle.Core.dll.meta create mode 100644 Runtime/Core/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta create mode 100644 Runtime/Core/Plugins/Microsoft.IdentityModel.Logging.dll.meta create mode 100644 Runtime/Core/Plugins/Microsoft.IdentityModel.Tokens.dll.meta create mode 100644 Runtime/Core/Plugins/Moq.dll.meta create mode 100644 Runtime/Core/Plugins/Serilog.Sinks.File.dll.meta create mode 100644 Runtime/Core/Plugins/Serilog.dll.meta create mode 100644 Runtime/Core/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta create mode 100644 Runtime/Core/Plugins/System.Threading.Tasks.Extensions.dll.meta create mode 100644 Runtime/Core/Plugins/YamlDotNet.dll.meta create mode 100644 Runtime/Core/README.md create mode 100644 Runtime/Core/README.md.meta create mode 100644 Runtime/Core/SettingsManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/SettingsManagement/ISettingsStore.cs (100%) create mode 100644 Runtime/Core/SettingsManagement/ISettingsStore.cs.meta create mode 100644 Runtime/Core/SettingsManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/SettingsManagement/Models/ClearSetting.cs (100%) create mode 100644 Runtime/Core/SettingsManagement/Models/ClearSetting.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/SettingsManagement/Models/GetSetting.cs (100%) create mode 100644 Runtime/Core/SettingsManagement/Models/GetSetting.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/SettingsManagement/Models/PutSetting.cs (100%) create mode 100644 Runtime/Core/SettingsManagement/Models/PutSetting.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/SettingsManagement/SettingsStore.cs (100%) create mode 100644 Runtime/Core/SettingsManagement/SettingsStore.cs.meta create mode 100644 Runtime/Core/Shared.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/AwsRegionMapper.cs (100%) create mode 100644 Runtime/Core/Shared/AwsRegionMapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/Bootstrapper.cs (100%) create mode 100644 Runtime/Core/Shared/Bootstrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/ErrorCode.cs (100%) create mode 100644 Runtime/Core/Shared/ErrorCode.cs.meta create mode 100644 Runtime/Core/Shared/FileSystem.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/FileSystem/FileWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/FileSystem/FileWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/FileSystem/IFileWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/FileSystem/IFileWrapper.cs.meta create mode 100644 Runtime/Core/Shared/FileZip.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/FileZip/FileZip.cs (100%) create mode 100644 Runtime/Core/Shared/FileZip/FileZip.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/FileZip/IFileZip.cs (100%) create mode 100644 Runtime/Core/Shared/FileZip/IFileZip.cs.meta create mode 100644 Runtime/Core/Shared/Logging.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/Logging/Logger.cs (100%) create mode 100644 Runtime/Core/Shared/Logging/Logger.cs.meta create mode 100644 Runtime/Core/Shared/ProcessManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/ProcessManagement/ExecutableNotFoundException.cs (100%) create mode 100644 Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/ProcessManagement/IProcessWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/ProcessManagement/ProcessWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/Response.cs (100%) create mode 100644 Runtime/Core/Shared/Response.cs.meta create mode 100644 Runtime/Core/Shared/S3Bucket.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/S3Bucket/AmazonS3Wrapper.cs (100%) create mode 100644 Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/S3Bucket/IAmazonS3Wrapper.cs (100%) create mode 100644 Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs.meta create mode 100644 Runtime/Core/Shared/SettingsStore.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/SettingsStore/IStreamWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/SettingsStore/YamlStreamWrapper.cs (100%) create mode 100644 Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/Shared/ValidationResult.cs (100%) create mode 100644 Runtime/Core/Shared/ValidationResult.cs.meta create mode 100644 Runtime/Core/UserIdentityManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/IUserIdentity.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/IUserIdentity.cs.meta create mode 100644 Runtime/Core/UserIdentityManagement/Models.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/Models/ConfirmSignUp.cs (100%) rename GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit.meta => Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs.meta (56%) rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/Models/RefreshToken.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/Models/SignIn.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/Models/SignIn.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/Models/SignOut.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/Models/SignOut.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/Models/SignUp.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/Models/SignUp.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core => Runtime/Core}/UserIdentityManagement/UserIdentity.cs (100%) create mode 100644 Runtime/Core/UserIdentityManagement/UserIdentity.cs.meta create mode 100644 Runtime/Core/csc.rsp create mode 100644 Runtime/Core/csc.rsp.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftClientSettings.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftClientSettings.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftConfiguration.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftConfiguration.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftCoreApi.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts => Runtime}/GameLiftCoreApi.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests => Runtime}/Plugins.meta (77%) create mode 100644 Runtime/Plugins/GameLiftServerSDKNet45.dll.config create mode 100644 Runtime/Plugins/GameLiftServerSDKNet45.dll.config.meta create mode 100644 Runtime/Plugins/GameLiftServerSDKNet45.dll.meta create mode 100644 Runtime/Plugins/Google.Protobuf.dll.meta create mode 100644 Runtime/Plugins/Google.Protobuf.pdb create mode 100644 Runtime/Plugins/Google.Protobuf.pdb.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/Google.Protobuf.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/Google.Protobuf.xml.meta (75%) create mode 100644 Runtime/Plugins/System.Buffers.dll.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Buffers.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Buffers.xml.meta (75%) create mode 100644 Runtime/Plugins/System.Collections.Immutable.dll.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Collections.Immutable.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Collections.Immutable.xml.meta (75%) create mode 100644 Runtime/Plugins/System.Memory.dll.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Memory.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Memory.xml.meta (75%) create mode 100644 Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Runtime.CompilerServices.Unsafe.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/System.Runtime.CompilerServices.Unsafe.xml.meta (75%) create mode 100644 Runtime/Plugins/log4net.dll.meta rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/log4net.xml (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK => Runtime/Plugins}/log4net.xml.meta (75%) create mode 100644 Runtime/Plugins/websocket-sharp.dll.meta create mode 100644 Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/AmazonGameLiftPlugin.Custom.asmdef.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/Deployer.cs (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/Deployer.cs.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/cloudformation.yml (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/cloudformation.yml.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/lambda.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/lambda/game_request.py (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/lambda/game_request.py.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/lambda/results_request.py (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/lambda/results_request.py.meta (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/parameters.json (100%) rename {GameLift-Unity/Assets/Editor/Custom Scenario => Samples~/CustomScenario}/parameters.json.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/.editorconfig (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/.gitignore (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Animations.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Animations/Spinner Animator Controller.controller (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Animations/Spinner Animator Controller.controller.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Animations/Spinner Rotate.anim (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Animations/Spinner Rotate.anim.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/ClientServerSwitchMenu.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/ClientServerSwitchMenu.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/UnityPackageExporter.cs (71%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Editor/Scripts/UnityPackageExporter.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/ConfirmationCodeScreen.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/ConfirmationCodeScreen.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/ConfirmationSuccessScreen.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/ConfirmationSuccessScreen.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/GameLiftStatic.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/GameLiftStatic.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/InputField.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/InputField.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/QuitCanvasStatic.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/QuitCanvasStatic.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SignInScreen.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SignInScreen.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SignUpScreen.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SignUpScreen.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/Spinner.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/Spinner.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/StartGameScreen.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/StartGameScreen.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SubmitButton.prefab (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Prefabs/SubmitButton.prefab.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color001.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color001.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color002.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color002.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color003.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color003.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color004.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color004.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color005.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color005.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color006.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color006.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color007.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color007.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color008.mat (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Resources/Materials/Color008.mat.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scenes.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scenes/BootstrapScene.unity (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scenes/BootstrapScene.unity.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scenes/GameScene.unity (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scenes/GameScene.unity.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Chord.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Chord.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/ClientCredentials.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/ClientCredentials.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/Delay.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/Delay.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/GameLiftClient.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/GameLiftClient.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/NetworkClient.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Client/NetworkClient.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/ClientBootstrap.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/ClientBootstrap.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLift.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLift.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLog.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLog.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLogic.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/GameLogic.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Global.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Global.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Input.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Input.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Logger.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Logger.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/NetworkProtocol.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/NetworkProtocol.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/QuitGame.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/QuitGame.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Render.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Render.cs.meta (100%) rename GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef => Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef (63%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/SampleGame.asmdef.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Server.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Server/GameLiftServer.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Server/GameLiftServer.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Server/NetworkServer.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Server/NetworkServer.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/ServerBootstrap.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/ServerBootstrap.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Simulation.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Simulation.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Status.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Status.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Strings.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/Strings.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ClientSettingsView.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ClientSettingsView.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ConfirmationCodeScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ConfirmationCodeScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ConfirmationSuccessScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/ConfirmationSuccessScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/FormScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/FormScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/GameScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/GameScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/SignInScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/SignInScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/SignUpScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/SignUpScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/StartGameScreen.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Scripts/UI/StartGameScreen.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Settings.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Settings/GameLiftClientSettings.asset (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Settings/GameLiftClientSettings.asset.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 1.png (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 1.png.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 2.png (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 2.png.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 3.png (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 3.png.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 4.png (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Sprites/UI/Spinner/Spinner 4.png.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/AssertAsync.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/AssertAsync.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/GameLiftClientTests.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/GameLiftClientTests.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef (72%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/AssetPaths.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/AssetPaths.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/AwsTestIdentity.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/AwsTestIdentity.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/GameLiftClientSettingsOverride.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/GameLiftClientSettingsOverride.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/GameObjectNames.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/GameObjectNames.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/PlayModeUtility.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/PlayModeUtility.cs.meta (100%) create mode 100644 Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SampleTests.UI.asmdef.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignInTests.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignInTests.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignUpTests.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/SignUpTests.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/StartGameTests.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/StartGameTests.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestInput.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestInput.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestSettings.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestSettings.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestSettingsSource.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/TestSettingsSource.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitForGameObjectFound.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitForGameObjectFound.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitForSceneLoaded.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitForSceneLoaded.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitUnitilCondition.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitUnitilCondition.cs.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitWithTimeOut.cs (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/Assets/Tests/UI/WaitWithTimeOut.cs.meta (100%) rename {GameLift-Unity => Samples~/SampleGame}/Packages/manifest.json (97%) rename {GameLift-SampleGame => Samples~/SampleGame}/README.md (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/README.md.meta (100%) rename {GameLift-SampleGame => Samples~/SampleGame}/UiTestSettings.json (100%) create mode 100644 Scripts~/windows/.build-core-library.ps1 create mode 100644 Scripts~/windows/.build-gamelift-server-sdk.ps1 create mode 100644 Scripts~/windows/.build-sample-game.ps1 create mode 100644 Scripts~/windows/.clean-builds.ps1 create mode 100644 Scripts~/windows/.clean-download-files.ps1 create mode 100644 Scripts~/windows/.clean-exports.ps1 create mode 100644 Scripts~/windows/build.ps1 create mode 100644 Scripts~/windows/clean.ps1 create mode 100644 Scripts~/windows/export.ps1 create mode 100644 Scripts~/windows/release.ps1 rename GameLift-Unity/Assets/com.amazonaws.gamelift/Tests.meta => Tests.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests => Tests}/Editor.meta (100%) create mode 100644 Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AmazonGameLiftPlugin.Editor.UnitTests.asmdef.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AssemblyInfo.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AssemblyInfo.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AssertAsync.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AssertAsync.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsCreationTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsCreationTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsUpdateTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/AwsCredentialsUpdateTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapBucketFormatterTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapBucketFormatterTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapSettingsTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapSettingsTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapUtilityTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BootstrapUtilityTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BucketUrlFormatterTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Bootstrap/BucketUrlFormatterTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/CoreApiMockExtensions.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/CoreApiMockExtensions.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/CoroutineTaskExtensions.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/CoroutineTaskExtensions.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeployerTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeployerTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentRequestFactoryTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentRequestFactoryTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentSettingsTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentSettingsTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentWaiterTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/DeploymentWaiterTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/ScenarioParametersUpdaterTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/ScenarioParametersUpdaterTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/TestedDeployer.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/TestedDeployer.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/UntilResponseFailurePollerTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/Deployment/UntilResponseFailurePollerTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/ImageLoaderTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/ImageLoaderTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/LocalTest.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/LocalTest/LocalTestTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/LocalTest/LocalTestTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/MockLogger.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/MockLogger.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/BootstrapSettingTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/BootstrapSettingTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/CredentialsSettingTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/CredentialsSettingTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/JavaSettingTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/PluginSettings/JavaSettingTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/RegionBootstrapTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/RegionBootstrapTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/StatusTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/StatusTests.cs.meta (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/TextProviderTests.cs (100%) rename {GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit => Tests/Editor}/TextProviderTests.cs.meta (100%) create mode 100644 Tests/Runtime.meta create mode 100644 Tests/Runtime/Core.meta create mode 100644 Tests/Runtime/Core/AccountManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/AccountManagement/AccountManagerTests.cs (100%) create mode 100644 Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs.meta create mode 100644 Tests/Runtime/Core/ApiGateWayManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/ApiGateWayManagement/ApiGatewayTests.cs (100%) create mode 100644 Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/ApiGateWayManagement/LocalGameAdapterTests.cs (100%) create mode 100644 Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs.meta create mode 100644 Tests/Runtime/Core/BucketManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/BucketManagement/BucketStoreTests.cs (100%) create mode 100644 Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs.meta create mode 100644 Tests/Runtime/Core/CredentialManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/CredentialManagement/CredentialsStoreTests.cs (100%) create mode 100644 Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs.meta create mode 100644 Tests/Runtime/Core/DeploymentManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/DeploymentManagement/DeploymentManagerTests.cs (100%) create mode 100644 Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs.meta create mode 100644 Tests/Runtime/Core/Factories.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/Factories/BucketStoreFactory.cs (100%) create mode 100644 Tests/Runtime/Core/Factories/BucketStoreFactory.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/Factories/CredentialsStoreFactory.cs (100%) create mode 100644 Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/Factories/SettingsStoreFactory.cs (100%) create mode 100644 Tests/Runtime/Core/Factories/SettingsStoreFactory.cs.meta create mode 100644 Tests/Runtime/Core/GameLiftLocalTesting.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/GameLiftLocalTesting/GameLiftProcessTests.cs (100%) create mode 100644 Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs.meta create mode 100644 Tests/Runtime/Core/InstalledJavaVersionCheck.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs (100%) create mode 100644 Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs (100%) create mode 100644 Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs.meta create mode 100644 Tests/Runtime/Core/Latency.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/Latency/LatencyServiceTests.cs (100%) create mode 100644 Tests/Runtime/Core/Latency/LatencyServiceTests.cs.meta create mode 100644 Tests/Runtime/Core/Properties.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/Properties/AssemblyInfo.cs (100%) create mode 100644 Tests/Runtime/Core/Properties/AssemblyInfo.cs.meta create mode 100644 Tests/Runtime/Core/SettingsManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/SettingsManagement/SettingsStoreTests.cs (100%) create mode 100644 Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs.meta create mode 100644 Tests/Runtime/Core/UserIdentityManagement.meta rename {AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests => Tests/Runtime/Core}/UserIdentityManagement/UserIdentityTests.cs (100%) create mode 100644 Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs.meta delete mode 100644 bin/windows/build.ps1 delete mode 100644 bin/windows/clean.ps1 delete mode 100644 bin/windows/setup.ps1 rename GameLift-Unity/Assets/com.amazonaws.gamelift/package.json => package.json (62%) rename GameLift-Unity/Assets/com.amazonaws.gamelift/package.json.meta => package.json.meta (100%) diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index a459a181..00000000 --- a/.gitattributes +++ /dev/null @@ -1,47 +0,0 @@ -# Text -*.cs text eol=lf -*.cpp text eol=lf -*.h text eol=lf -*.sln text eol=lf -*.csproj text eol=lf -*.vcxproj text eol=lf -# Unity text -*.prefab text eol=lf -*.asset text eol=lf -*.meta text eol=lf -# 3D models -*.3dm -text -*.3ds -text -*.blend -text -*.c4d -text -*.collada -text -*.dae -text -*.dxf -text -*.fbx -text -*.jas -text -*.lws -text -*.lxo -text -*.ma -text -*.max -text -*.mb -text -*.obj -text -*.ply -text -*.skp -text -*.stl -text -*.ztl -text -# Audio -*.aif -text -*.aiff -text -*.mp3 -text -*.ogg -text -*.wav -text -# Fonts -*.otf -text -*.ttf -text -# Images -*.bmp -text -*.hdr -text -*.jpeg -text -*.jpg -text -*.png -text -*.psd -text \ No newline at end of file diff --git a/.gitignore b/.gitignore index 923d7c7e..cbe63c89 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,6 @@ -/build/ .vs/ +*.dll +*.unitypackage +*.tgz +*.tgz.meta +SampleGameBuildLog.txt \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..ac6e92de --- /dev/null +++ b/.npmignore @@ -0,0 +1,5 @@ +.vs/ +.git/ +Scripts~/ +*.tgz +*.tgz.meta diff --git a/AmazonGameLiftPlugin.Core/.editorconfig b/AmazonGameLiftPlugin.Core/.editorconfig deleted file mode 100644 index 699f4b98..00000000 --- a/AmazonGameLiftPlugin.Core/.editorconfig +++ /dev/null @@ -1,263 +0,0 @@ -# editorconfig.org - -# top-most EditorConfig file -root = true - -# Default settings: -# A newline ending every file -# Use 4 spaces as indentation -[*] -insert_final_newline = true -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true -charset = utf-8 -end_of_line = lf - -guidelines = 100 - -# C# files -[*.cs] - -#### .NET Coding Conventions #### - -# Organize usings -dotnet_separate_import_directive_groups = false -dotnet_sort_system_directives_first = true -file_header_template = Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\nSPDX-License-Identifier: Apache-2.0 - -# this. and Me. preferences -dotnet_style_qualification_for_event = false:suggestion -dotnet_style_qualification_for_field = false:suggestion -dotnet_style_qualification_for_method = false:suggestion -dotnet_style_qualification_for_property = false:suggestion - -# Language keywords vs BCL types preferences -dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion -dotnet_style_predefined_type_for_member_access = true:suggestion - -# Parentheses preferences -dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent -dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent -dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent -dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent - -# Modifier preferences -dotnet_style_require_accessibility_modifiers = always:warning - -# Expression-level preferences -dotnet_style_object_initializer = true:suggestion -dotnet_style_collection_initializer = true:suggestion -dotnet_style_explicit_tuple_names = true:suggestion -dotnet_style_coalesce_expression = true:suggestion -dotnet_style_null_propagation = true:suggestion -dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion -dotnet_style_prefer_inferred_tuple_names = true:suggestion -dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion -dotnet_style_prefer_auto_properties = true:suggestion -dotnet_style_prefer_conditional_expression_over_assignment = true:silent -dotnet_style_prefer_conditional_expression_over_return = true:silent - -# Code quality -dotnet_style_readonly_field = true:suggestion -dotnet_code_quality_unused_parameters = non_public:suggestion - -# Suppression preferences -dotnet_remove_unnecessary_suppression_exclusions = none - -#### C# Coding Conventions #### - -# var preferences -csharp_style_var_elsewhere = false:warning -csharp_style_var_for_built_in_types = false:warning -csharp_style_var_when_type_is_apparent = true:warning - -# Expression-bodied members -csharp_style_expression_bodied_accessors = true:silent -csharp_style_expression_bodied_methods = true:silent -csharp_style_expression_bodied_constructors = true:silent -csharp_style_expression_bodied_operators = true:silent -csharp_style_expression_bodied_properties = true:silent -csharp_style_expression_bodied_indexers = true:silent -csharp_style_expression_bodied_lambdas = true:silent -csharp_style_expression_bodied_local_functions = true:silent - -# Pattern matching preferences -csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion -csharp_style_pattern_matching_over_as_with_null_check = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_prefer_not_pattern = true:suggestion -csharp_style_prefer_pattern_matching = true:silent -csharp_style_prefer_switch_expression = true:suggestion - -# Null checking preferences -csharp_style_throw_expression = true:suggestion -csharp_style_conditional_delegate_call = true:suggestion - -# Modifier preferences -csharp_prefer_static_local_function = true:suggestion -csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning - -# Code style defaults -csharp_using_directive_placement = outside_namespace:suggestion -csharp_prefer_braces = true:silent -csharp_prefer_simple_using_statement = false:none -csharp_style_prefer_switch_expression = true:suggestion - -# Expression-level preferences -csharp_prefer_simple_default_expression = true:suggestion -csharp_style_deconstructed_variable_declaration = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_pattern_local_over_anonymous_function = true:suggestion -csharp_style_prefer_index_operator = true:suggestion -csharp_style_prefer_range_operator = true:suggestion -csharp_style_unused_value_assignment_preference = discard_variable:suggestion -csharp_style_unused_value_expression_statement_preference = discard_variable:silent - -#### C# Formatting Rules #### - -# New line preferences -csharp_new_line_before_catch = true -csharp_new_line_before_else = true -csharp_new_line_before_finally = true -csharp_new_line_before_members_in_anonymous_types = true -csharp_new_line_before_members_in_object_initializers = true -csharp_new_line_before_open_brace = all -csharp_new_line_between_query_expression_clauses = true - -# Indentation preferences -csharp_indent_block_contents = true -csharp_indent_braces = false -csharp_indent_case_contents = true -csharp_indent_case_contents_when_block = true -csharp_indent_labels = one_less_than_current -csharp_indent_switch_labels = true - -# Space preferences -csharp_space_after_cast = false -csharp_space_after_colon_in_inheritance_clause = true -csharp_space_after_comma = true -csharp_space_after_dot = false -csharp_space_after_keywords_in_control_flow_statements = true -csharp_space_after_semicolon_in_for_statement = true -csharp_space_around_binary_operators = before_and_after -csharp_space_around_declaration_statements = do_not_ignore -csharp_space_before_colon_in_inheritance_clause = true -csharp_space_before_comma = false -csharp_space_before_dot = false -csharp_space_before_open_square_brackets = false -csharp_space_before_semicolon_in_for_statement = false -csharp_space_between_empty_square_brackets = false -csharp_space_between_method_call_empty_parameter_list_parentheses = false -csharp_space_between_method_call_name_and_opening_parenthesis = false -csharp_space_between_method_call_parameter_list_parentheses = false -csharp_space_between_method_declaration_empty_parameter_list_parentheses = false -csharp_space_between_method_declaration_name_and_open_parenthesis = false -csharp_space_between_method_declaration_parameter_list_parentheses = false -csharp_space_between_parentheses = false -csharp_space_between_square_brackets = false - -# Wrapping preferences -csharp_preserve_single_line_blocks = true:none -csharp_preserve_single_line_statements = false:none - -#### Naming styles #### - -# namespaces should be pascal case -dotnet_naming_rule.namespaces_should_be_pascal_case.severity = warning -dotnet_naming_rule.namespaces_should_be_pascal_case.symbols = namespaces -dotnet_naming_rule.namespaces_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.namespaces.applicable_kinds = namespace - -# type parameters should be pascal case -dotnet_naming_rule.type_parameters_should_be_pascal_case.severity = warning -dotnet_naming_rule.type_parameters_should_be_pascal_case.symbols = type_parameter -dotnet_naming_rule.type_parameters_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.type_parameters.applicable_kinds = type_parameter - -# types should be pascal case -dotnet_naming_rule.types_should_be_pascal_case.severity = warning -dotnet_naming_rule.types_should_be_pascal_case.symbols = types -dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum -dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected -dotnet_naming_symbols.types.required_modifiers = - -# interfaces should have I prefix -dotnet_naming_rule.interface_should_be_begins_with_i_style.severity = warning -dotnet_naming_rule.interface_should_be_begins_with_i_style.symbols = interface -dotnet_naming_rule.interface_should_be_begins_with_i_style.style = begins_with_i_style -dotnet_naming_symbols.interface.applicable_kinds = interface -dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected -dotnet_naming_symbols.interface.required_modifiers = -dotnet_naming_style.begins_with_i_style.required_prefix = I -dotnet_naming_style.begins_with_i_style.required_suffix = -dotnet_naming_style.begins_with_i_style.word_separator = -dotnet_naming_style.begins_with_i_style.capitalization = pascal_case - -# non-field members should be pascal case -dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning -dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members -dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method -dotnet_naming_symbols.non_field_members.applicable_accessibilities = internal, private, protected, protected_internal, private_protected - -# public members should be pascal case -dotnet_naming_rule.public_members_should_be_pascal_case.severity = warning -dotnet_naming_rule.public_members_should_be_pascal_case.symbols = public_members -dotnet_naming_rule.public_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.public_members.applicable_kinds = field, property, event, method -dotnet_naming_symbols.public_members.applicable_accessibilities = public -dotnet_naming_symbols.public_members.required_modifiers = - -# name all constant fields using PascalCase -dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning -dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields -dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.constant_fields.applicable_kinds = field -dotnet_naming_symbols.constant_fields.required_modifiers = const - -# static fields should have s_ prefix -dotnet_naming_rule.static_fields_should_have_prefix.severity = warning -dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields -dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style -dotnet_naming_symbols.static_fields.applicable_kinds = field -dotnet_naming_symbols.static_fields.required_modifiers = static -dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected -dotnet_naming_style.static_prefix_style.required_prefix = s_ -dotnet_naming_style.static_prefix_style.capitalization = camel_case - -# internal and private fields should be _camelCase -dotnet_naming_rule.camel_case_for_private_internal_fields.severity = warning -dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields -dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style -dotnet_naming_symbols.private_internal_fields.applicable_kinds = field -dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal - -# variables should be camel case -dotnet_naming_rule.variables_should_be_camel_case.severity = warning -dotnet_naming_rule.variables_should_be_camel_case.symbols = variables -dotnet_naming_rule.variables_should_be_camel_case.style = camel_case_style -dotnet_naming_symbols.variables.applicable_kinds = parameter, local - -# Naming styles - -dotnet_naming_style.camel_case_style.capitalization = camel_case - -dotnet_naming_style.pascal_case_style.capitalization = pascal_case - -dotnet_naming_style.camel_case_underscore_style.required_prefix = _ -dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case - -# Analyzers -dotnet_code_quality.CA1052.api_surface = private, internal -dotnet_code_quality.CA1802.api_surface = private, internal -dotnet_code_quality.CA1822.api_surface = private, internal -dotnet_code_quality.CA2208.api_surface = public - -# Shell scripts -[*.sh] -end_of_line = lf -[*.{cmd,bat}] -end_of_line = crlf diff --git a/AmazonGameLiftPlugin.Core/.gitignore b/AmazonGameLiftPlugin.Core/.gitignore deleted file mode 100644 index 964ded71..00000000 --- a/AmazonGameLiftPlugin.Core/.gitignore +++ /dev/null @@ -1,351 +0,0 @@ -/.vs/ -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. -## -## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore - -# User-specific files -*.rsuser -*.suo -*.user -*.userosscache -*.sln.docstates - -# User-specific files (MonoDevelop/Xamarin Studio) -*.userprefs - -# Mono auto generated files -mono_crash.* - -# Build results -[Dd]ebug/ -[Dd]ebugPublic/ -[Rr]elease/ -[Rr]eleases/ -x64/ -x86/ -[Aa][Rr][Mm]/ -[Aa][Rr][Mm]64/ -bld/ -[Bb]in/ -[Oo]bj/ -[Ll]og/ -[Ll]ogs/ - -# Visual Studio 2015/2017 cache/options directory -.vs/ -# Uncomment if you have tasks that create the project's static files in wwwroot -#wwwroot/ - -# Visual Studio 2017 auto generated files -Generated\ Files/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -# NUnit -*.VisualState.xml -TestResult.xml -nunit-*.xml - -# Build Results of an ATL Project -[Dd]ebugPS/ -[Rr]eleasePS/ -dlldata.c - -# Benchmark Results -BenchmarkDotNet.Artifacts/ - -# .NET Core -project.lock.json -project.fragment.lock.json -artifacts/ - -# StyleCop -StyleCopReport.xml - -# Files built by Visual Studio -*_i.c -*_p.c -*_h.h -*.ilk -*.meta -*.obj -*.iobj -*.pch -*.pdb -*.ipdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj -*_wpftmp.csproj -*.log -*.vspscc -*.vssscc -.builds -*.pidb -*.svclog -*.scc - -# Chutzpah Test files -_Chutzpah* - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opendb -*.opensdf -*.sdf -*.cachefile -*.VC.db -*.VC.VC.opendb - -# Visual Studio profiler -*.psess -*.vsp -*.vspx -*.sap - -# Visual Studio Trace Files -*.e2e - -# TFS 2012 Local Workspace -$tf/ - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper -*.DotSettings.user - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# AxoCover is a Code Coverage Tool -.axoCover/* -!.axoCover/settings.json - -# Visual Studio code coverage results -*.coverage -*.coveragexml - -# NCrunch -_NCrunch_* -.*crunch*.local.xml -nCrunchTemp_* - -# MightyMoose -*.mm.* -AutoTest.Net/ - -# Web workbench (sass) -.sass-cache/ - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.[Pp]ublish.xml -*.azurePubxml -# Note: Comment the next line if you want to checkin your web deploy settings, -# but database connection strings (with potential passwords) will be unencrypted -*.pubxml -*.publishproj - -# Microsoft Azure Web App publish settings. Comment the next line if you want to -# checkin your Azure Web App publish settings, but sensitive information contained -# in these scripts will be unencrypted -PublishScripts/ - -# NuGet Packages -*.nupkg -# NuGet Symbol Packages -*.snupkg -# The packages folder can be ignored because of Package Restore -**/[Pp]ackages/* -# except build/, which is used as an MSBuild target. -!**/[Pp]ackages/build/ -# Uncomment if necessary however generally it will be regenerated when needed -#!**/[Pp]ackages/repositories.config -# NuGet v3's project.json files produces more ignorable files -*.nuget.props -*.nuget.targets - -# Microsoft Azure Build Output -csx/ -*.build.csdef - -# Microsoft Azure Emulator -ecf/ -rcf/ - -# Windows Store app package directories and files -AppPackages/ -BundleArtifacts/ -Package.StoreAssociation.xml -_pkginfo.txt -*.appx -*.appxbundle -*.appxupload - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!?*.[Cc]ache/ - -# Others -ClientBin/ -~$* -*~ -*.dbmdl -*.dbproj.schemaview -*.jfm -*.pfx -*.publishsettings -orleans.codegen.cs - -# Including strong name files can present a security risk -# (https://github.com/github/gitignore/pull/2483#issue-259490424) -#*.snk - -# Since there are multiple workflows, uncomment next line to ignore bower_components -# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) -#bower_components/ - -# RIA/Silverlight projects -Generated_Code/ - -# Backup & report files from converting an old project file -# to a newer Visual Studio version. Backup files are not needed, -# because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm -ServiceFabricBackup/ -*.rptproj.bak - -# SQL Server files -*.mdf -*.ldf -*.ndf - -# Business Intelligence projects -*.rdl.data -*.bim.layout -*.bim_*.settings -*.rptproj.rsuser -*- [Bb]ackup.rdl -*- [Bb]ackup ([0-9]).rdl -*- [Bb]ackup ([0-9][0-9]).rdl - -# Microsoft Fakes -FakesAssemblies/ - -# GhostDoc plugin setting file -*.GhostDoc.xml - -# Node.js Tools for Visual Studio -.ntvs_analysis.dat -node_modules/ - -# Visual Studio 6 build log -*.plg - -# Visual Studio 6 workspace options file -*.opt - -# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) -*.vbw - -# Visual Studio LightSwitch build output -**/*.HTMLClient/GeneratedArtifacts -**/*.DesktopClient/GeneratedArtifacts -**/*.DesktopClient/ModelManifest.xml -**/*.Server/GeneratedArtifacts -**/*.Server/ModelManifest.xml -_Pvt_Extensions - -# Paket dependency manager -.paket/paket.exe -paket-files/ - -# FAKE - F# Make -.fake/ - -# CodeRush personal settings -.cr/personal - -# Python Tools for Visual Studio (PTVS) -__pycache__/ -*.pyc - -# Cake - Uncomment if you are using it -# tools/** -# !tools/packages.config - -# Tabs Studio -*.tss - -# Telerik's JustMock configuration file -*.jmconfig - -# BizTalk build output -*.btp.cs -*.btm.cs -*.odx.cs -*.xsd.cs - -# OpenCover UI analysis results -OpenCover/ - -# Azure Stream Analytics local run output -ASALocalRun/ - -# MSBuild Binary and Structured Log -*.binlog - -# NVidia Nsight GPU debugger configuration file -*.nvuser - -# MFractors (Xamarin productivity tool) working folder -.mfractor/ - -# Local History for Visual Studio -.localhistory/ - -# BeatPulse healthcheck temp database -healthchecksdb - -# Backup folder for Package Reference Convert tool in Visual Studio 2017 -MigrationBackup/ - -# Ionide (cross platform F# VS Code tools) working folder -.ionide/ \ No newline at end of file diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AmazonGameLiftPlugin.Core.Tests.csproj b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AmazonGameLiftPlugin.Core.Tests.csproj deleted file mode 100644 index b4bdfc41..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AmazonGameLiftPlugin.Core.Tests.csproj +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - Debug - AnyCPU - {E65F9109-48E9-4698-9C1B-5EF88BB8458C} - Library - Properties - AmazonGameLiftPlugin.Core.Tests - AmazonGameLiftPlugin.Core.Tests - v4.7.1 - 512 - {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} - 15.0 - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - $(ProgramFiles)\Common Files\microsoft shared\VSTT\$(VisualStudioVersion)\UITestExtensionPackages - False - UnitTest - - - - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - ..\packages\AWSSDK.CloudFormation.3.7.3.2\lib\net45\AWSSDK.CloudFormation.dll - - - ..\packages\AWSSDK.CognitoIdentityProvider.3.7.1.14\lib\net45\AWSSDK.CognitoIdentityProvider.dll - - - ..\packages\AWSSDK.Core.3.7.1.3\lib\net45\AWSSDK.Core.dll - - - ..\packages\AWSSDK.GameLift.3.7.0.47\lib\net45\AWSSDK.GameLift.dll - - - ..\packages\AWSSDK.S3.3.7.1.3\lib\net45\AWSSDK.S3.dll - - - ..\packages\AWSSDK.SecurityToken.3.7.1.23\lib\net45\AWSSDK.SecurityToken.dll - - - ..\packages\Castle.Core.4.4.0\lib\net45\Castle.Core.dll - - - ..\packages\Moq.4.16.1\lib\net45\Moq.dll - - - ..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll - - - ..\packages\NUnit.3.13.2\lib\net45\nunit.framework.dll - - - - - - - ..\packages\System.Runtime.CompilerServices.Unsafe.4.5.3\lib\net461\System.Runtime.CompilerServices.Unsafe.dll - - - ..\packages\System.Threading.Tasks.Extensions.4.5.4\lib\net461\System.Threading.Tasks.Extensions.dll - - - ..\packages\System.ValueTuple.4.5.0\lib\net47\System.ValueTuple.dll - - - ..\packages\YamlDotNet.11.2.0\lib\net45\YamlDotNet.dll - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3} - AmazonGameLiftPlugin.Core - - - - - - - - - - - - - - - This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}. - - - - - \ No newline at end of file diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/packages.config b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/packages.config deleted file mode 100644 index febedfe5..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/packages.config +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.sln b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.sln deleted file mode 100644 index 30f376a7..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.sln +++ /dev/null @@ -1,36 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.31321.278 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AmazonGameLiftPlugin.Core", "AmazonGameLiftPlugin.Core\AmazonGameLiftPlugin.Core.csproj", "{122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AmazonGameLiftPlugin.Core.Tests", "AmazonGameLiftPlugin.Core.Tests\AmazonGameLiftPlugin.Core.Tests.csproj", "{E65F9109-48E9-4698-9C1B-5EF88BB8458C}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{93D6DE37-FC3F-4487-8342-BD693FF32D13}" - ProjectSection(SolutionItems) = preProject - .editorconfig = .editorconfig - EndProjectSection -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3}.Debug|Any CPU.Build.0 = Debug|Any CPU - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3}.Release|Any CPU.ActiveCfg = Release|Any CPU - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3}.Release|Any CPU.Build.0 = Release|Any CPU - {E65F9109-48E9-4698-9C1B-5EF88BB8458C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E65F9109-48E9-4698-9C1B-5EF88BB8458C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {E65F9109-48E9-4698-9C1B-5EF88BB8458C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {E65F9109-48E9-4698-9C1B-5EF88BB8458C}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {FA86EBEC-78DE-4182-9898-3FA8089ABD76} - EndGlobalSection -EndGlobal diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.csproj b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.csproj deleted file mode 100644 index 3e2fef43..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.csproj +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Debug - AnyCPU - {122E9F7C-4CE8-46AC-BD6D-2CDF0B2222E3} - Library - Properties - AmazonGameLiftPlugin.Core - AmazonGameLiftPlugin.Core - v4.7.1 - 512 - true - - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - ..\packages\AWSSDK.CloudFormation.3.7.3.2\lib\net45\AWSSDK.CloudFormation.dll - - - ..\packages\AWSSDK.CognitoIdentityProvider.3.7.1.13\lib\net45\AWSSDK.CognitoIdentityProvider.dll - - - ..\packages\AWSSDK.Core.3.7.1.3\lib\net45\AWSSDK.Core.dll - - - ..\packages\AWSSDK.GameLift.3.7.0.47\lib\net45\AWSSDK.GameLift.dll - - - ..\packages\AWSSDK.S3.3.7.1.3\lib\net45\AWSSDK.S3.dll - - - ..\packages\AWSSDK.SecurityToken.3.7.1.23\lib\net45\AWSSDK.SecurityToken.dll - - - ..\packages\Microsoft.IdentityModel.JsonWebTokens.6.11.1\lib\net461\Microsoft.IdentityModel.JsonWebTokens.dll - - - ..\packages\Microsoft.IdentityModel.Logging.6.11.1\lib\net461\Microsoft.IdentityModel.Logging.dll - - - ..\packages\Microsoft.IdentityModel.Tokens.6.11.1\lib\net461\Microsoft.IdentityModel.Tokens.dll - - - ..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll - - - ..\packages\Serilog.2.10.0\lib\net46\Serilog.dll - - - ..\packages\Serilog.Sinks.File.5.0.0\lib\net45\Serilog.Sinks.File.dll - - - - - ..\packages\System.IdentityModel.Tokens.Jwt.6.11.1\lib\net461\System.IdentityModel.Tokens.Jwt.dll - - - - - - - - - - - ..\packages\YamlDotNet.11.2.0\lib\net45\YamlDotNet.dll - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Properties/AssemblyInfo.cs b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Properties/AssemblyInfo.cs deleted file mode 100644 index 4d6d19d5..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Properties/AssemblyInfo.cs +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// SPDX-License-Identifier: Apache-2.0 - -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("AmazonGameLiftPlugin.Core")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("Amazon")] -[assembly: AssemblyProduct("AmazonGameLiftPlugin.Core.Tests")] -[assembly: AssemblyCopyright("Copyright © Amazon . 2021")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("54623CF2-1E9B-4495-89D7-89CA6E5D511F")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -[assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/packages.config b/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/packages.config deleted file mode 100644 index 102e0831..00000000 --- a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/packages.config +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e699a8c..563127df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ CHANGELOG +# 1.1.0 (09/28/2021) +- Files + - Update project file structure to comply with [Unity standards](https://docs.unity3d.com/Manual/CustomPackages.html) + - Move package.json into project root; remove unnecessary Unity project wrapper + - Move Core Library under `Runtime`; change .csproj to use the vs2019 convention and updated to use dotnet build tool to resolve dependencies + - Move sample game project to `Sample~` + - Move scripts to `Scripts~`; modularize scripts and add more fail-fast mechanisms + - Use npm to package the plugin tarball + - Remove other misc files + - Update assembly definition namings to comply with [Unity convention](https://docs.unity3d.com/Manual/cus-tests.html) +- Documentation + - Update and re-format READMEs + - Use the correct URL for deployment scenario help link + # 1.0.0 (09/17/2021) - Documentation diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml.meta b/CHANGELOG.md.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml.meta rename to CHANGELOG.md.meta index fa6a48d0..1dab4f7c 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml.meta +++ b/CHANGELOG.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: b9b1a0e5d5620bf4cb6ba019e5310571 +guid: cd9ddb7452d257f49b78cd3dbe5d180f TextScriptImporter: externalObjects: {} userData: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml.meta b/CODE_OF_CONDUCT.md.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml.meta rename to CODE_OF_CONDUCT.md.meta index 10457bf5..8be8f213 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml.meta +++ b/CODE_OF_CONDUCT.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 0cd344f9dbe2f304487c83930fd77357 +guid: 6cb2aa2ebe5bc9d479e466291a28e234 TextScriptImporter: externalObjects: {} userData: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml.meta b/CONTRIBUTING.md.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml.meta rename to CONTRIBUTING.md.meta index 48044a49..05fe18b2 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml.meta +++ b/CONTRIBUTING.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 173fd1941dac52d4790d1c2dc2143710 +guid: 0a8b0382f8067a04dbd2f9984ae5cbbe TextScriptImporter: externalObjects: {} userData: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor.meta b/Editor.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor.meta rename to Editor.meta diff --git a/Editor/AmazonGameLiftPlugin.Editor.asmdef b/Editor/AmazonGameLiftPlugin.Editor.asmdef new file mode 100644 index 00000000..3faa522e --- /dev/null +++ b/Editor/AmazonGameLiftPlugin.Editor.asmdef @@ -0,0 +1,20 @@ +{ + "name": "AmazonGameLiftPlugin.Editor", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef.meta b/Editor/AmazonGameLiftPlugin.Editor.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef.meta rename to Editor/AmazonGameLiftPlugin.Editor.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssemblyInfo.cs b/Editor/AssemblyInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssemblyInfo.cs rename to Editor/AssemblyInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssemblyInfo.cs.meta b/Editor/AssemblyInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssemblyInfo.cs.meta rename to Editor/AssemblyInfo.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssetNames.cs b/Editor/AssetNames.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssetNames.cs rename to Editor/AssetNames.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssetNames.cs.meta b/Editor/AssetNames.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AssetNames.cs.meta rename to Editor/AssetNames.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap.meta b/Editor/Bootstrap.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap.meta rename to Editor/Bootstrap.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapBucketFormatter.cs b/Editor/Bootstrap/BootstrapBucketFormatter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapBucketFormatter.cs rename to Editor/Bootstrap/BootstrapBucketFormatter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapBucketFormatter.cs.meta b/Editor/Bootstrap/BootstrapBucketFormatter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapBucketFormatter.cs.meta rename to Editor/Bootstrap/BootstrapBucketFormatter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettings.cs b/Editor/Bootstrap/BootstrapSettings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettings.cs rename to Editor/Bootstrap/BootstrapSettings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettings.cs.meta b/Editor/Bootstrap/BootstrapSettings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettings.cs.meta rename to Editor/Bootstrap/BootstrapSettings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettingsFactory.cs b/Editor/Bootstrap/BootstrapSettingsFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettingsFactory.cs rename to Editor/Bootstrap/BootstrapSettingsFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettingsFactory.cs.meta b/Editor/Bootstrap/BootstrapSettingsFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapSettingsFactory.cs.meta rename to Editor/Bootstrap/BootstrapSettingsFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapWindow.cs b/Editor/Bootstrap/BootstrapWindow.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapWindow.cs rename to Editor/Bootstrap/BootstrapWindow.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapWindow.cs.meta b/Editor/Bootstrap/BootstrapWindow.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BootstrapWindow.cs.meta rename to Editor/Bootstrap/BootstrapWindow.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs b/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs rename to Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs.meta b/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs.meta rename to Editor/Bootstrap/BucketLifecyclePolicyTextProvider.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs b/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs rename to Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs.meta b/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs.meta rename to Editor/Bootstrap/BucketLifecyclePolicyTextProviderFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketUrlFormatter.cs b/Editor/Bootstrap/BucketUrlFormatter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketUrlFormatter.cs rename to Editor/Bootstrap/BucketUrlFormatter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketUrlFormatter.cs.meta b/Editor/Bootstrap/BucketUrlFormatter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/BucketUrlFormatter.cs.meta rename to Editor/Bootstrap/BucketUrlFormatter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/IBucketNameFormatter.cs b/Editor/Bootstrap/IBucketNameFormatter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/IBucketNameFormatter.cs rename to Editor/Bootstrap/IBucketNameFormatter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/IBucketNameFormatter.cs.meta b/Editor/Bootstrap/IBucketNameFormatter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/IBucketNameFormatter.cs.meta rename to Editor/Bootstrap/IBucketNameFormatter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/RegionBootstrap.cs b/Editor/Bootstrap/RegionBootstrap.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/RegionBootstrap.cs rename to Editor/Bootstrap/RegionBootstrap.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/RegionBootstrap.cs.meta b/Editor/Bootstrap/RegionBootstrap.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Bootstrap/RegionBootstrap.cs.meta rename to Editor/Bootstrap/RegionBootstrap.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls.meta b/Editor/Controls.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls.meta rename to Editor/Controls.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawer.cs b/Editor/Controls/ControlDrawer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawer.cs rename to Editor/Controls/ControlDrawer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawer.cs.meta b/Editor/Controls/ControlDrawer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawer.cs.meta rename to Editor/Controls/ControlDrawer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawerFactory.cs b/Editor/Controls/ControlDrawerFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawerFactory.cs rename to Editor/Controls/ControlDrawerFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawerFactory.cs.meta b/Editor/Controls/ControlDrawerFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ControlDrawerFactory.cs.meta rename to Editor/Controls/ControlDrawerFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/Dialog.cs b/Editor/Controls/Dialog.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/Dialog.cs rename to Editor/Controls/Dialog.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/Dialog.cs.meta b/Editor/Controls/Dialog.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/Dialog.cs.meta rename to Editor/Controls/Dialog.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/DialogAction.cs b/Editor/Controls/DialogAction.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/DialogAction.cs rename to Editor/Controls/DialogAction.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/DialogAction.cs.meta b/Editor/Controls/DialogAction.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/DialogAction.cs.meta rename to Editor/Controls/DialogAction.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/GuiLayoutImageSequenceDrawer.cs b/Editor/Controls/GuiLayoutImageSequenceDrawer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/GuiLayoutImageSequenceDrawer.cs rename to Editor/Controls/GuiLayoutImageSequenceDrawer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/GuiLayoutImageSequenceDrawer.cs.meta b/Editor/Controls/GuiLayoutImageSequenceDrawer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/GuiLayoutImageSequenceDrawer.cs.meta rename to Editor/Controls/GuiLayoutImageSequenceDrawer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ImageSequenceDrawer.cs b/Editor/Controls/ImageSequenceDrawer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ImageSequenceDrawer.cs rename to Editor/Controls/ImageSequenceDrawer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ImageSequenceDrawer.cs.meta b/Editor/Controls/ImageSequenceDrawer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/ImageSequenceDrawer.cs.meta rename to Editor/Controls/ImageSequenceDrawer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/SpinnerDrawerFactory.cs b/Editor/Controls/SpinnerDrawerFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/SpinnerDrawerFactory.cs rename to Editor/Controls/SpinnerDrawerFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/SpinnerDrawerFactory.cs.meta b/Editor/Controls/SpinnerDrawerFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/SpinnerDrawerFactory.cs.meta rename to Editor/Controls/SpinnerDrawerFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/StatusLabel.cs b/Editor/Controls/StatusLabel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/StatusLabel.cs rename to Editor/Controls/StatusLabel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/StatusLabel.cs.meta b/Editor/Controls/StatusLabel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Controls/StatusLabel.cs.meta rename to Editor/Controls/StatusLabel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI.meta b/Editor/CoreAPI.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI.meta rename to Editor/CoreAPI.meta diff --git a/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef b/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef new file mode 100644 index 00000000..c727bdb4 --- /dev/null +++ b/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef @@ -0,0 +1,18 @@ +{ + "name": "AmazonGameLiftPlugin.EditorCoreAPI", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": false, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef.meta b/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef.meta rename to Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AssemblyInfo.cs b/Editor/CoreAPI/AssemblyInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AssemblyInfo.cs rename to Editor/CoreAPI/AssemblyInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AssemblyInfo.cs.meta b/Editor/CoreAPI/AssemblyInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AssemblyInfo.cs.meta rename to Editor/CoreAPI/AssemblyInfo.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/BootstrapUtility.cs b/Editor/CoreAPI/BootstrapUtility.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/BootstrapUtility.cs rename to Editor/CoreAPI/BootstrapUtility.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/BootstrapUtility.cs.meta b/Editor/CoreAPI/BootstrapUtility.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/BootstrapUtility.cs.meta rename to Editor/CoreAPI/BootstrapUtility.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ChangeSetExecutionStatus.cs b/Editor/CoreAPI/ChangeSetExecutionStatus.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ChangeSetExecutionStatus.cs rename to Editor/CoreAPI/ChangeSetExecutionStatus.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ChangeSetExecutionStatus.cs.meta b/Editor/CoreAPI/ChangeSetExecutionStatus.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ChangeSetExecutionStatus.cs.meta rename to Editor/CoreAPI/ChangeSetExecutionStatus.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ConfirmChangesDelegate.cs b/Editor/CoreAPI/ConfirmChangesDelegate.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ConfirmChangesDelegate.cs rename to Editor/CoreAPI/ConfirmChangesDelegate.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ConfirmChangesDelegate.cs.meta b/Editor/CoreAPI/ConfirmChangesDelegate.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ConfirmChangesDelegate.cs.meta rename to Editor/CoreAPI/ConfirmChangesDelegate.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/CoreApi.cs b/Editor/CoreAPI/CoreApi.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/CoreApi.cs rename to Editor/CoreAPI/CoreApi.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/CoreApi.cs.meta b/Editor/CoreAPI/CoreApi.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/CoreApi.cs.meta rename to Editor/CoreAPI/CoreApi.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Delay.cs b/Editor/CoreAPI/Delay.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Delay.cs rename to Editor/CoreAPI/Delay.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Delay.cs.meta b/Editor/CoreAPI/Delay.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Delay.cs.meta rename to Editor/CoreAPI/Delay.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeployerBase.cs b/Editor/CoreAPI/DeployerBase.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeployerBase.cs rename to Editor/CoreAPI/DeployerBase.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeployerBase.cs.meta b/Editor/CoreAPI/DeployerBase.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeployerBase.cs.meta rename to Editor/CoreAPI/DeployerBase.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentInfo.cs b/Editor/CoreAPI/DeploymentInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentInfo.cs rename to Editor/CoreAPI/DeploymentInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentInfo.cs.meta b/Editor/CoreAPI/DeploymentInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentInfo.cs.meta rename to Editor/CoreAPI/DeploymentInfo.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentRequestFactory.cs b/Editor/CoreAPI/DeploymentRequestFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentRequestFactory.cs rename to Editor/CoreAPI/DeploymentRequestFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentRequestFactory.cs.meta b/Editor/CoreAPI/DeploymentRequestFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentRequestFactory.cs.meta rename to Editor/CoreAPI/DeploymentRequestFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentWaiter.cs b/Editor/CoreAPI/DeploymentWaiter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentWaiter.cs rename to Editor/CoreAPI/DeploymentWaiter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentWaiter.cs.meta b/Editor/CoreAPI/DeploymentWaiter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/DeploymentWaiter.cs.meta rename to Editor/CoreAPI/DeploymentWaiter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ErrorCode.cs b/Editor/CoreAPI/ErrorCode.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ErrorCode.cs rename to Editor/CoreAPI/ErrorCode.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ErrorCode.cs.meta b/Editor/CoreAPI/ErrorCode.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ErrorCode.cs.meta rename to Editor/CoreAPI/ErrorCode.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/IResponsePoller.cs b/Editor/CoreAPI/IResponsePoller.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/IResponsePoller.cs rename to Editor/CoreAPI/IResponsePoller.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/IResponsePoller.cs.meta b/Editor/CoreAPI/IResponsePoller.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/IResponsePoller.cs.meta rename to Editor/CoreAPI/IResponsePoller.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models.meta b/Editor/CoreAPI/Models.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models.meta rename to Editor/CoreAPI/Models.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/ConfirmChangesRequest.cs b/Editor/CoreAPI/Models/ConfirmChangesRequest.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/ConfirmChangesRequest.cs rename to Editor/CoreAPI/Models/ConfirmChangesRequest.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/ConfirmChangesRequest.cs.meta b/Editor/CoreAPI/Models/ConfirmChangesRequest.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/ConfirmChangesRequest.cs.meta rename to Editor/CoreAPI/Models/ConfirmChangesRequest.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentId.cs b/Editor/CoreAPI/Models/DeploymentId.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentId.cs rename to Editor/CoreAPI/Models/DeploymentId.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentId.cs.meta b/Editor/CoreAPI/Models/DeploymentId.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentId.cs.meta rename to Editor/CoreAPI/Models/DeploymentId.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentRequest.cs b/Editor/CoreAPI/Models/DeploymentRequest.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentRequest.cs rename to Editor/CoreAPI/Models/DeploymentRequest.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentRequest.cs.meta b/Editor/CoreAPI/Models/DeploymentRequest.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentRequest.cs.meta rename to Editor/CoreAPI/Models/DeploymentRequest.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentResponse.cs b/Editor/CoreAPI/Models/DeploymentResponse.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentResponse.cs rename to Editor/CoreAPI/Models/DeploymentResponse.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentResponse.cs.meta b/Editor/CoreAPI/Models/DeploymentResponse.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/DeploymentResponse.cs.meta rename to Editor/CoreAPI/Models/DeploymentResponse.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/FileReadAllTextResponse.cs b/Editor/CoreAPI/Models/FileReadAllTextResponse.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/FileReadAllTextResponse.cs rename to Editor/CoreAPI/Models/FileReadAllTextResponse.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/FileReadAllTextResponse.cs.meta b/Editor/CoreAPI/Models/FileReadAllTextResponse.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/FileReadAllTextResponse.cs.meta rename to Editor/CoreAPI/Models/FileReadAllTextResponse.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs b/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs rename to Editor/CoreAPI/Models/GetBootstrapDataResponse.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs.meta b/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/GetBootstrapDataResponse.cs.meta rename to Editor/CoreAPI/Models/GetBootstrapDataResponse.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/SaveParametersResponse.cs b/Editor/CoreAPI/Models/SaveParametersResponse.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/SaveParametersResponse.cs rename to Editor/CoreAPI/Models/SaveParametersResponse.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/SaveParametersResponse.cs.meta b/Editor/CoreAPI/Models/SaveParametersResponse.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Models/SaveParametersResponse.cs.meta rename to Editor/CoreAPI/Models/SaveParametersResponse.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Paths.cs b/Editor/CoreAPI/Paths.cs similarity index 89% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Paths.cs rename to Editor/CoreAPI/Paths.cs index f5d25b4b..99cd305c 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Paths.cs +++ b/Editor/CoreAPI/Paths.cs @@ -7,7 +7,7 @@ public static class Paths { public const string PluginSettingsFile = "GameLiftSettings.yaml"; public const string PackageName = "com.amazonaws.gamelift"; - public const string SampleGameInPackage = "Examples~/SampleGame"; + public const string SampleGameInPackage = "Samples~/SampleGame.unitypackage"; public const string ScenariosRootInPackage = "Editor/Resources/CloudFormation"; public const string LambdaFolderPathInScenario = "lambda"; public const string CfnTemplateFileName = "cloudformation.yml"; diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Paths.cs.meta b/Editor/CoreAPI/Paths.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/Paths.cs.meta rename to Editor/CoreAPI/Paths.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameter.cs b/Editor/CoreAPI/ScenarioParameter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameter.cs rename to Editor/CoreAPI/ScenarioParameter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameter.cs.meta b/Editor/CoreAPI/ScenarioParameter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameter.cs.meta rename to Editor/CoreAPI/ScenarioParameter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameterKeys.cs b/Editor/CoreAPI/ScenarioParameterKeys.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameterKeys.cs rename to Editor/CoreAPI/ScenarioParameterKeys.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameterKeys.cs.meta b/Editor/CoreAPI/ScenarioParameterKeys.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParameterKeys.cs.meta rename to Editor/CoreAPI/ScenarioParameterKeys.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParametersEditor.cs b/Editor/CoreAPI/ScenarioParametersEditor.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParametersEditor.cs rename to Editor/CoreAPI/ScenarioParametersEditor.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParametersEditor.cs.meta b/Editor/CoreAPI/ScenarioParametersEditor.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/ScenarioParametersEditor.cs.meta rename to Editor/CoreAPI/ScenarioParametersEditor.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/SettingsKeys.cs b/Editor/CoreAPI/SettingsKeys.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/SettingsKeys.cs rename to Editor/CoreAPI/SettingsKeys.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/SettingsKeys.cs.meta b/Editor/CoreAPI/SettingsKeys.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/SettingsKeys.cs.meta rename to Editor/CoreAPI/SettingsKeys.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackOutputKeys.cs b/Editor/CoreAPI/StackOutputKeys.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackOutputKeys.cs rename to Editor/CoreAPI/StackOutputKeys.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackOutputKeys.cs.meta b/Editor/CoreAPI/StackOutputKeys.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackOutputKeys.cs.meta rename to Editor/CoreAPI/StackOutputKeys.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackStatus.cs b/Editor/CoreAPI/StackStatus.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackStatus.cs rename to Editor/CoreAPI/StackStatus.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackStatus.cs.meta b/Editor/CoreAPI/StackStatus.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/StackStatus.cs.meta rename to Editor/CoreAPI/StackStatus.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/UntilResponseFailurePoller.cs b/Editor/CoreAPI/UntilResponseFailurePoller.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/UntilResponseFailurePoller.cs rename to Editor/CoreAPI/UntilResponseFailurePoller.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/UntilResponseFailurePoller.cs.meta b/Editor/CoreAPI/UntilResponseFailurePoller.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/UntilResponseFailurePoller.cs.meta rename to Editor/CoreAPI/UntilResponseFailurePoller.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials.meta b/Editor/Credentials.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials.meta rename to Editor/Credentials.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentials.cs b/Editor/Credentials/AwsCredentials.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentials.cs rename to Editor/Credentials/AwsCredentials.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentials.cs.meta b/Editor/Credentials/AwsCredentials.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentials.cs.meta rename to Editor/Credentials/AwsCredentials.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreation.cs b/Editor/Credentials/AwsCredentialsCreation.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreation.cs rename to Editor/Credentials/AwsCredentialsCreation.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreation.cs.meta b/Editor/Credentials/AwsCredentialsCreation.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreation.cs.meta rename to Editor/Credentials/AwsCredentialsCreation.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreationPanel.cs b/Editor/Credentials/AwsCredentialsCreationPanel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreationPanel.cs rename to Editor/Credentials/AwsCredentialsCreationPanel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreationPanel.cs.meta b/Editor/Credentials/AwsCredentialsCreationPanel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsCreationPanel.cs.meta rename to Editor/Credentials/AwsCredentialsCreationPanel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsFactory.cs b/Editor/Credentials/AwsCredentialsFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsFactory.cs rename to Editor/Credentials/AwsCredentialsFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsFactory.cs.meta b/Editor/Credentials/AwsCredentialsFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsFactory.cs.meta rename to Editor/Credentials/AwsCredentialsFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdate.cs b/Editor/Credentials/AwsCredentialsUpdate.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdate.cs rename to Editor/Credentials/AwsCredentialsUpdate.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdate.cs.meta b/Editor/Credentials/AwsCredentialsUpdate.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdate.cs.meta rename to Editor/Credentials/AwsCredentialsUpdate.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdatePanel.cs b/Editor/Credentials/AwsCredentialsUpdatePanel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdatePanel.cs rename to Editor/Credentials/AwsCredentialsUpdatePanel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdatePanel.cs.meta b/Editor/Credentials/AwsCredentialsUpdatePanel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsUpdatePanel.cs.meta rename to Editor/Credentials/AwsCredentialsUpdatePanel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsWindow.cs b/Editor/Credentials/AwsCredentialsWindow.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsWindow.cs rename to Editor/Credentials/AwsCredentialsWindow.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsWindow.cs.meta b/Editor/Credentials/AwsCredentialsWindow.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/AwsCredentialsWindow.cs.meta rename to Editor/Credentials/AwsCredentialsWindow.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/PasswordDrawer.cs b/Editor/Credentials/PasswordDrawer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/PasswordDrawer.cs rename to Editor/Credentials/PasswordDrawer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/PasswordDrawer.cs.meta b/Editor/Credentials/PasswordDrawer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/PasswordDrawer.cs.meta rename to Editor/Credentials/PasswordDrawer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/Strings.cs b/Editor/Credentials/Strings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/Strings.cs rename to Editor/Credentials/Strings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/Strings.cs.meta b/Editor/Credentials/Strings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Credentials/Strings.cs.meta rename to Editor/Credentials/Strings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment.meta b/Editor/Deployment.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment.meta rename to Editor/Deployment.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ChangeSetUrlFormatter.cs b/Editor/Deployment/ChangeSetUrlFormatter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ChangeSetUrlFormatter.cs rename to Editor/Deployment/ChangeSetUrlFormatter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ChangeSetUrlFormatter.cs.meta b/Editor/Deployment/ChangeSetUrlFormatter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ChangeSetUrlFormatter.cs.meta rename to Editor/Deployment/ChangeSetUrlFormatter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DelayedOperation.cs b/Editor/Deployment/DelayedOperation.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DelayedOperation.cs rename to Editor/Deployment/DelayedOperation.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DelayedOperation.cs.meta b/Editor/Deployment/DelayedOperation.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DelayedOperation.cs.meta rename to Editor/Deployment/DelayedOperation.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainer.cs b/Editor/Deployment/DeploymentIdContainer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainer.cs rename to Editor/Deployment/DeploymentIdContainer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainer.cs.meta b/Editor/Deployment/DeploymentIdContainer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainer.cs.meta rename to Editor/Deployment/DeploymentIdContainer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainerFactory.cs b/Editor/Deployment/DeploymentIdContainerFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainerFactory.cs rename to Editor/Deployment/DeploymentIdContainerFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainerFactory.cs.meta b/Editor/Deployment/DeploymentIdContainerFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentIdContainerFactory.cs.meta rename to Editor/Deployment/DeploymentIdContainerFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettings.cs b/Editor/Deployment/DeploymentSettings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettings.cs rename to Editor/Deployment/DeploymentSettings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettings.cs.meta b/Editor/Deployment/DeploymentSettings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettings.cs.meta rename to Editor/Deployment/DeploymentSettings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettingsFactory.cs b/Editor/Deployment/DeploymentSettingsFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettingsFactory.cs rename to Editor/Deployment/DeploymentSettingsFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettingsFactory.cs.meta b/Editor/Deployment/DeploymentSettingsFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentSettingsFactory.cs.meta rename to Editor/Deployment/DeploymentSettingsFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfo.cs b/Editor/Deployment/DeploymentStackInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfo.cs rename to Editor/Deployment/DeploymentStackInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfo.cs.meta b/Editor/Deployment/DeploymentStackInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfo.cs.meta rename to Editor/Deployment/DeploymentStackInfo.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfoFactory.cs b/Editor/Deployment/DeploymentStackInfoFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfoFactory.cs rename to Editor/Deployment/DeploymentStackInfoFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfoFactory.cs.meta b/Editor/Deployment/DeploymentStackInfoFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentStackInfoFactory.cs.meta rename to Editor/Deployment/DeploymentStackInfoFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentWindow.cs b/Editor/Deployment/DeploymentWindow.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentWindow.cs rename to Editor/Deployment/DeploymentWindow.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentWindow.cs.meta b/Editor/Deployment/DeploymentWindow.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/DeploymentWindow.cs.meta rename to Editor/Deployment/DeploymentWindow.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/IDeploymentIdContainer.cs b/Editor/Deployment/IDeploymentIdContainer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/IDeploymentIdContainer.cs rename to Editor/Deployment/IDeploymentIdContainer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/IDeploymentIdContainer.cs.meta b/Editor/Deployment/IDeploymentIdContainer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/IDeploymentIdContainer.cs.meta rename to Editor/Deployment/IDeploymentIdContainer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/PathConverter.cs b/Editor/Deployment/PathConverter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/PathConverter.cs rename to Editor/Deployment/PathConverter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/PathConverter.cs.meta b/Editor/Deployment/PathConverter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/PathConverter.cs.meta rename to Editor/Deployment/PathConverter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioLocator.cs b/Editor/Deployment/ScenarioLocator.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioLocator.cs rename to Editor/Deployment/ScenarioLocator.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioLocator.cs.meta b/Editor/Deployment/ScenarioLocator.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioLocator.cs.meta rename to Editor/Deployment/ScenarioLocator.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioParametersUpdater.cs b/Editor/Deployment/ScenarioParametersUpdater.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioParametersUpdater.cs rename to Editor/Deployment/ScenarioParametersUpdater.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioParametersUpdater.cs.meta b/Editor/Deployment/ScenarioParametersUpdater.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/ScenarioParametersUpdater.cs.meta rename to Editor/Deployment/ScenarioParametersUpdater.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateDialog.cs b/Editor/Deployment/StackUpdateDialog.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateDialog.cs rename to Editor/Deployment/StackUpdateDialog.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateDialog.cs.meta b/Editor/Deployment/StackUpdateDialog.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateDialog.cs.meta rename to Editor/Deployment/StackUpdateDialog.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModel.cs b/Editor/Deployment/StackUpdateModel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModel.cs rename to Editor/Deployment/StackUpdateModel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModel.cs.meta b/Editor/Deployment/StackUpdateModel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModel.cs.meta rename to Editor/Deployment/StackUpdateModel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModelFactory.cs b/Editor/Deployment/StackUpdateModelFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModelFactory.cs rename to Editor/Deployment/StackUpdateModelFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModelFactory.cs.meta b/Editor/Deployment/StackUpdateModelFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Deployment/StackUpdateModelFactory.cs.meta rename to Editor/Deployment/StackUpdateModelFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/DevStrings.cs b/Editor/DevStrings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/DevStrings.cs rename to Editor/DevStrings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/DevStrings.cs.meta b/Editor/DevStrings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/DevStrings.cs.meta rename to Editor/DevStrings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorMenu.cs b/Editor/EditorMenu.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorMenu.cs rename to Editor/EditorMenu.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorMenu.cs.meta b/Editor/EditorMenu.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorMenu.cs.meta rename to Editor/EditorMenu.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorWindowExtensions.cs b/Editor/EditorWindowExtensions.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorWindowExtensions.cs rename to Editor/EditorWindowExtensions.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorWindowExtensions.cs.meta b/Editor/EditorWindowExtensions.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/EditorWindowExtensions.cs.meta rename to Editor/EditorWindowExtensions.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/GameLiftClientSettingsEditor.cs b/Editor/GameLiftClientSettingsEditor.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/GameLiftClientSettingsEditor.cs rename to Editor/GameLiftClientSettingsEditor.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/GameLiftClientSettingsEditor.cs.meta b/Editor/GameLiftClientSettingsEditor.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/GameLiftClientSettingsEditor.cs.meta rename to Editor/GameLiftClientSettingsEditor.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/HyperLinkButton.cs b/Editor/HyperLinkButton.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/HyperLinkButton.cs rename to Editor/HyperLinkButton.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/HyperLinkButton.cs.meta b/Editor/HyperLinkButton.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/HyperLinkButton.cs.meta rename to Editor/HyperLinkButton.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ILogger.cs b/Editor/ILogger.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ILogger.cs rename to Editor/ILogger.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ILogger.cs.meta b/Editor/ILogger.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ILogger.cs.meta rename to Editor/ILogger.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/IReadStatus.cs b/Editor/IReadStatus.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/IReadStatus.cs rename to Editor/IReadStatus.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/IReadStatus.cs.meta b/Editor/IReadStatus.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/IReadStatus.cs.meta rename to Editor/IReadStatus.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ImageLoader.cs b/Editor/ImageLoader.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ImageLoader.cs rename to Editor/ImageLoader.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ImageLoader.cs.meta b/Editor/ImageLoader.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ImageLoader.cs.meta rename to Editor/ImageLoader.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest.meta b/Editor/LocalTest.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest.meta rename to Editor/LocalTest.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTest.cs b/Editor/LocalTest/LocalTest.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTest.cs rename to Editor/LocalTest/LocalTest.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTest.cs.meta b/Editor/LocalTest/LocalTest.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTest.cs.meta rename to Editor/LocalTest/LocalTest.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestFactory.cs b/Editor/LocalTest/LocalTestFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestFactory.cs rename to Editor/LocalTest/LocalTestFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestFactory.cs.meta b/Editor/LocalTest/LocalTestFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestFactory.cs.meta rename to Editor/LocalTest/LocalTestFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestWindow.cs b/Editor/LocalTest/LocalTestWindow.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestWindow.cs rename to Editor/LocalTest/LocalTestWindow.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestWindow.cs.meta b/Editor/LocalTest/LocalTestWindow.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/LocalTestWindow.cs.meta rename to Editor/LocalTest/LocalTestWindow.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/SettingsFormatter.cs b/Editor/LocalTest/SettingsFormatter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/SettingsFormatter.cs rename to Editor/LocalTest/SettingsFormatter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/SettingsFormatter.cs.meta b/Editor/LocalTest/SettingsFormatter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/LocalTest/SettingsFormatter.cs.meta rename to Editor/LocalTest/SettingsFormatter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings.meta b/Editor/PluginSettings.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings.meta rename to Editor/PluginSettings.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/BootstrapSetting.cs b/Editor/PluginSettings/BootstrapSetting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/BootstrapSetting.cs rename to Editor/PluginSettings/BootstrapSetting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/BootstrapSetting.cs.meta b/Editor/PluginSettings/BootstrapSetting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/BootstrapSetting.cs.meta rename to Editor/PluginSettings/BootstrapSetting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/CredentialsSetting.cs b/Editor/PluginSettings/CredentialsSetting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/CredentialsSetting.cs rename to Editor/PluginSettings/CredentialsSetting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/CredentialsSetting.cs.meta b/Editor/PluginSettings/CredentialsSetting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/CredentialsSetting.cs.meta rename to Editor/PluginSettings/CredentialsSetting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/DotNetSetting.cs b/Editor/PluginSettings/DotNetSetting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/DotNetSetting.cs rename to Editor/PluginSettings/DotNetSetting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/DotNetSetting.cs.meta b/Editor/PluginSettings/DotNetSetting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/DotNetSetting.cs.meta rename to Editor/PluginSettings/DotNetSetting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/FirstTimeSettingsLauncher.cs b/Editor/PluginSettings/FirstTimeSettingsLauncher.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/FirstTimeSettingsLauncher.cs rename to Editor/PluginSettings/FirstTimeSettingsLauncher.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/FirstTimeSettingsLauncher.cs.meta b/Editor/PluginSettings/FirstTimeSettingsLauncher.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/FirstTimeSettingsLauncher.cs.meta rename to Editor/PluginSettings/FirstTimeSettingsLauncher.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftLocalSetting.cs b/Editor/PluginSettings/GameLiftLocalSetting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftLocalSetting.cs rename to Editor/PluginSettings/GameLiftLocalSetting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftLocalSetting.cs.meta b/Editor/PluginSettings/GameLiftLocalSetting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftLocalSetting.cs.meta rename to Editor/PluginSettings/GameLiftLocalSetting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftSettingPanel.cs b/Editor/PluginSettings/GameLiftSettingPanel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftSettingPanel.cs rename to Editor/PluginSettings/GameLiftSettingPanel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftSettingPanel.cs.meta b/Editor/PluginSettings/GameLiftSettingPanel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/GameLiftSettingPanel.cs.meta rename to Editor/PluginSettings/GameLiftSettingPanel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/JavaSetting.cs b/Editor/PluginSettings/JavaSetting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/JavaSetting.cs rename to Editor/PluginSettings/JavaSetting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/JavaSetting.cs.meta b/Editor/PluginSettings/JavaSetting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/JavaSetting.cs.meta rename to Editor/PluginSettings/JavaSetting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Setting.cs b/Editor/PluginSettings/Setting.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Setting.cs rename to Editor/PluginSettings/Setting.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Setting.cs.meta b/Editor/PluginSettings/Setting.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Setting.cs.meta rename to Editor/PluginSettings/Setting.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingPanel.cs b/Editor/PluginSettings/SettingPanel.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingPanel.cs rename to Editor/PluginSettings/SettingPanel.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingPanel.cs.meta b/Editor/PluginSettings/SettingPanel.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingPanel.cs.meta rename to Editor/PluginSettings/SettingPanel.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Settings.cs b/Editor/PluginSettings/Settings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Settings.cs rename to Editor/PluginSettings/Settings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Settings.cs.meta b/Editor/PluginSettings/Settings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/Settings.cs.meta rename to Editor/PluginSettings/Settings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsChecker.cs b/Editor/PluginSettings/SettingsChecker.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsChecker.cs rename to Editor/PluginSettings/SettingsChecker.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsChecker.cs.meta b/Editor/PluginSettings/SettingsChecker.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsChecker.cs.meta rename to Editor/PluginSettings/SettingsChecker.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsState.cs b/Editor/PluginSettings/SettingsState.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsState.cs rename to Editor/PluginSettings/SettingsState.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsState.cs.meta b/Editor/PluginSettings/SettingsState.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsState.cs.meta rename to Editor/PluginSettings/SettingsState.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsWindow.cs b/Editor/PluginSettings/SettingsWindow.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsWindow.cs rename to Editor/PluginSettings/SettingsWindow.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsWindow.cs.meta b/Editor/PluginSettings/SettingsWindow.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/PluginSettings/SettingsWindow.cs.meta rename to Editor/PluginSettings/SettingsWindow.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ResourceUtility.cs b/Editor/ResourceUtility.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ResourceUtility.cs rename to Editor/ResourceUtility.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ResourceUtility.cs.meta b/Editor/ResourceUtility.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/ResourceUtility.cs.meta rename to Editor/ResourceUtility.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources.meta b/Editor/Resources.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources.meta rename to Editor/Resources.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation.meta b/Editor/Resources/CloudFormation.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation.meta rename to Editor/Resources/CloudFormation.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md b/Editor/Resources/CloudFormation/README.md similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md rename to Editor/Resources/CloudFormation/README.md diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md.meta b/Editor/Resources/CloudFormation/README.md.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/README.md.meta rename to Editor/Resources/CloudFormation/README.md.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common.meta b/Editor/Resources/CloudFormation/common.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common.meta rename to Editor/Resources/CloudFormation/common.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests.meta b/Editor/Resources/CloudFormation/common/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests.meta rename to Editor/Resources/CloudFormation/common/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests/loadtest.yml b/Editor/Resources/CloudFormation/common/tests/loadtest.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests/loadtest.yml rename to Editor/Resources/CloudFormation/common/tests/loadtest.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests/loadtest.yml.meta b/Editor/Resources/CloudFormation/common/tests/loadtest.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/common/tests/loadtest.yml.meta rename to Editor/Resources/CloudFormation/common/tests/loadtest.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only.meta b/Editor/Resources/CloudFormation/scenario1_auth_only.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only.meta diff --git a/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef b/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef new file mode 100644 index 00000000..203f9da4 --- /dev/null +++ b/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.AuthOnly", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs b/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs rename to Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml b/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml rename to Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/lambda.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py b/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py rename to Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py b/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py rename to Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json b/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json rename to Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/parameters.json.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py b/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py rename to Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py.meta b/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py.meta rename to Editor/Resources/CloudFormation/scenario1_auth_only/tests/test.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet.meta diff --git a/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef b/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef new file mode 100644 index 00000000..122318e3 --- /dev/null +++ b/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.SingleFleet", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs b/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs rename to Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml b/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml rename to Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/lambda.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py b/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py rename to Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py b/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py rename to Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json b/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json rename to Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/parameters.json.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py b/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py rename to Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py.meta b/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py.meta rename to Editor/Resources/CloudFormation/scenario2_single_fleet/tests/test.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue.meta diff --git a/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef b/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef new file mode 100644 index 00000000..6615963a --- /dev/null +++ b/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.MrfQueue", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs b/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml b/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/game_session_event_handler.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/lambda/simple_matchmaker.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json b/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/parameters.json.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py b/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py.meta b/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py.meta rename to Editor/Resources/CloudFormation/scenario3_mrf_queue/tests/test.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets.meta diff --git a/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef b/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef new file mode 100644 index 00000000..99a27359 --- /dev/null +++ b/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.SpotFleets", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs b/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml b/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/game_session_event_handler.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/lambda/simple_matchmaker.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json b/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/parameters.json.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py b/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py.meta b/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py.meta rename to Editor/Resources/CloudFormation/scenario4_spot_fleets/tests/test.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch.meta diff --git a/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef b/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef new file mode 100644 index 00000000..07e361e9 --- /dev/null +++ b/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.FlexMatch", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs b/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs rename to Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml b/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml rename to Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/flexmatch_status_poller.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/matchmaker_event_handler.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json b/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json rename to Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/parameters.json.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py b/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py rename to Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py.meta b/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py.meta rename to Editor/Resources/CloudFormation/scenario5_flexmatch/tests/test.py.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images.meta b/Editor/Resources/Images.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images.meta rename to Editor/Resources/Images.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark.meta b/Editor/Resources/Images/Dark.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark.meta rename to Editor/Resources/Images/Dark.meta diff --git a/GameLift-Unity/Assets/.gitignore b/Editor/Resources/Images/Dark/.gitignore similarity index 100% rename from GameLift-Unity/Assets/.gitignore rename to Editor/Resources/Images/Dark/.gitignore diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/GameLiftLogo.png b/Editor/Resources/Images/Dark/GameLiftLogo.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/GameLiftLogo.png rename to Editor/Resources/Images/Dark/GameLiftLogo.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/GameLiftLogo.png.meta b/Editor/Resources/Images/Dark/GameLiftLogo.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/GameLiftLogo.png.meta rename to Editor/Resources/Images/Dark/GameLiftLogo.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 1.png b/Editor/Resources/Images/Dark/Spinner 1.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 1.png rename to Editor/Resources/Images/Dark/Spinner 1.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 1.png.meta b/Editor/Resources/Images/Dark/Spinner 1.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 1.png.meta rename to Editor/Resources/Images/Dark/Spinner 1.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 2.png b/Editor/Resources/Images/Dark/Spinner 2.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 2.png rename to Editor/Resources/Images/Dark/Spinner 2.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 2.png.meta b/Editor/Resources/Images/Dark/Spinner 2.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 2.png.meta rename to Editor/Resources/Images/Dark/Spinner 2.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 3.png b/Editor/Resources/Images/Dark/Spinner 3.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 3.png rename to Editor/Resources/Images/Dark/Spinner 3.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 3.png.meta b/Editor/Resources/Images/Dark/Spinner 3.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 3.png.meta rename to Editor/Resources/Images/Dark/Spinner 3.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 4.png b/Editor/Resources/Images/Dark/Spinner 4.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 4.png rename to Editor/Resources/Images/Dark/Spinner 4.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 4.png.meta b/Editor/Resources/Images/Dark/Spinner 4.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/Spinner 4.png.meta rename to Editor/Resources/Images/Dark/Spinner 4.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light.meta b/Editor/Resources/Images/Light.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light.meta rename to Editor/Resources/Images/Light.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/.gitignore b/Editor/Resources/Images/Light/.gitignore similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Dark/.gitignore rename to Editor/Resources/Images/Light/.gitignore diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/GameLiftLogo.png b/Editor/Resources/Images/Light/GameLiftLogo.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/GameLiftLogo.png rename to Editor/Resources/Images/Light/GameLiftLogo.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/GameLiftLogo.png.meta b/Editor/Resources/Images/Light/GameLiftLogo.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/GameLiftLogo.png.meta rename to Editor/Resources/Images/Light/GameLiftLogo.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 1.png b/Editor/Resources/Images/Light/Spinner 1.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 1.png rename to Editor/Resources/Images/Light/Spinner 1.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 1.png.meta b/Editor/Resources/Images/Light/Spinner 1.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 1.png.meta rename to Editor/Resources/Images/Light/Spinner 1.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 2.png b/Editor/Resources/Images/Light/Spinner 2.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 2.png rename to Editor/Resources/Images/Light/Spinner 2.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 2.png.meta b/Editor/Resources/Images/Light/Spinner 2.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 2.png.meta rename to Editor/Resources/Images/Light/Spinner 2.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 3.png b/Editor/Resources/Images/Light/Spinner 3.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 3.png rename to Editor/Resources/Images/Light/Spinner 3.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 3.png.meta b/Editor/Resources/Images/Light/Spinner 3.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 3.png.meta rename to Editor/Resources/Images/Light/Spinner 3.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 4.png b/Editor/Resources/Images/Light/Spinner 4.png similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 4.png rename to Editor/Resources/Images/Light/Spinner 4.png diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 4.png.meta b/Editor/Resources/Images/Light/Spinner 4.png.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/Spinner 4.png.meta rename to Editor/Resources/Images/Light/Spinner 4.png.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Status.cs b/Editor/Status.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Status.cs rename to Editor/Status.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Status.cs.meta b/Editor/Status.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Status.cs.meta rename to Editor/Status.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextFilter.cs b/Editor/TextFilter.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextFilter.cs rename to Editor/TextFilter.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextFilter.cs.meta b/Editor/TextFilter.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextFilter.cs.meta rename to Editor/TextFilter.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProvider.cs b/Editor/TextProvider.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProvider.cs rename to Editor/TextProvider.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProvider.cs.meta b/Editor/TextProvider.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProvider.cs.meta rename to Editor/TextProvider.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProviderFactory.cs b/Editor/TextProviderFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProviderFactory.cs rename to Editor/TextProviderFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProviderFactory.cs.meta b/Editor/TextProviderFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/TextProviderFactory.cs.meta rename to Editor/TextProviderFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLogger.cs b/Editor/UnityLogger.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLogger.cs rename to Editor/UnityLogger.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLogger.cs.meta b/Editor/UnityLogger.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLogger.cs.meta rename to Editor/UnityLogger.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLoggerFactory.cs b/Editor/UnityLoggerFactory.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLoggerFactory.cs rename to Editor/UnityLoggerFactory.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLoggerFactory.cs.meta b/Editor/UnityLoggerFactory.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/UnityLoggerFactory.cs.meta rename to Editor/UnityLoggerFactory.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs b/Editor/Urls.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs rename to Editor/Urls.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs.meta b/Editor/Urls.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Urls.cs.meta rename to Editor/Urls.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef b/GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef deleted file mode 100644 index d47650ea..00000000 --- a/GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef +++ /dev/null @@ -1,23 +0,0 @@ -{ - "name": "SampleGame", - "references": [ - "AmazonGameLiftPlugin.Runtime" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor", - "WindowsStandalone64" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AWSSDK.Core.dll", - "AWSSDK.GameLift.dll", - "AWSSDK.SecurityToken.dll", - "GameLiftServerSDKNet45.dll", - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef b/GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef deleted file mode 100644 index a210fac5..00000000 --- a/GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef +++ /dev/null @@ -1,24 +0,0 @@ -{ - "name": "SampleTests.UI", - "references": [ - "AmazonGameLiftPlugin.Runtime", - "SampleGame" - ], - "optionalUnityReferences": [ - "TestAssemblies" - ], - "includePlatforms": [], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AWSSDK.CognitoIdentityProvider.dll", - "AWSSDK.Core.dll", - "Newtonsoft.Json.dll", - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [ - "!UNITY_SERVER" - ] -} \ No newline at end of file diff --git a/GameLift-SampleGame/Packages/manifest.json b/GameLift-SampleGame/Packages/manifest.json deleted file mode 100644 index 73076770..00000000 --- a/GameLift-SampleGame/Packages/manifest.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "dependencies": { - "com.amazonaws.gamelift": "file:../../GameLift-Unity/Assets/com.amazonaws.gamelift", - "com.unity.2d.sprite": "1.0.0", - "com.unity.2d.tilemap": "1.0.0", - "com.unity.ide.rider": "2.0.7", - "com.unity.ide.visualstudio": "2.0.11", - "com.unity.ide.vscode": "1.2.3", - "com.unity.test-framework": "1.1.27", - "com.unity.timeline": "1.4.8", - "com.unity.ugui": "1.0.0", - "com.unity.xr.legacyinputhelpers": "2.1.7", - "com.unity.modules.ai": "1.0.0", - "com.unity.modules.androidjni": "1.0.0", - "com.unity.modules.animation": "1.0.0", - "com.unity.modules.assetbundle": "1.0.0", - "com.unity.modules.audio": "1.0.0", - "com.unity.modules.cloth": "1.0.0", - "com.unity.modules.director": "1.0.0", - "com.unity.modules.imageconversion": "1.0.0", - "com.unity.modules.imgui": "1.0.0", - "com.unity.modules.jsonserialize": "1.0.0", - "com.unity.modules.particlesystem": "1.0.0", - "com.unity.modules.physics": "1.0.0", - "com.unity.modules.physics2d": "1.0.0", - "com.unity.modules.screencapture": "1.0.0", - "com.unity.modules.terrain": "1.0.0", - "com.unity.modules.terrainphysics": "1.0.0", - "com.unity.modules.tilemap": "1.0.0", - "com.unity.modules.ui": "1.0.0", - "com.unity.modules.uielements": "1.0.0", - "com.unity.modules.umbra": "1.0.0", - "com.unity.modules.unityanalytics": "1.0.0", - "com.unity.modules.unitywebrequest": "1.0.0", - "com.unity.modules.unitywebrequestassetbundle": "1.0.0", - "com.unity.modules.unitywebrequestaudio": "1.0.0", - "com.unity.modules.unitywebrequesttexture": "1.0.0", - "com.unity.modules.unitywebrequestwww": "1.0.0", - "com.unity.modules.vehicles": "1.0.0", - "com.unity.modules.video": "1.0.0", - "com.unity.modules.vr": "1.0.0", - "com.unity.modules.wind": "1.0.0", - "com.unity.modules.xr": "1.0.0" - } -} diff --git a/GameLift-SampleGame/ProjectSettings/AudioManager.asset b/GameLift-SampleGame/ProjectSettings/AudioManager.asset deleted file mode 100644 index 27287fec..00000000 --- a/GameLift-SampleGame/ProjectSettings/AudioManager.asset +++ /dev/null @@ -1,19 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!11 &1 -AudioManager: - m_ObjectHideFlags: 0 - serializedVersion: 2 - m_Volume: 1 - Rolloff Scale: 1 - Doppler Factor: 1 - Default Speaker Mode: 2 - m_SampleRate: 0 - m_DSPBufferSize: 1024 - m_VirtualVoiceCount: 512 - m_RealVoiceCount: 32 - m_SpatializerPlugin: - m_AmbisonicDecoderPlugin: - m_DisableAudio: 0 - m_VirtualizeEffects: 1 - m_RequestedDSPBufferSize: 0 diff --git a/GameLift-SampleGame/ProjectSettings/ClusterInputManager.asset b/GameLift-SampleGame/ProjectSettings/ClusterInputManager.asset deleted file mode 100644 index e7886b26..00000000 --- a/GameLift-SampleGame/ProjectSettings/ClusterInputManager.asset +++ /dev/null @@ -1,6 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!236 &1 -ClusterInputManager: - m_ObjectHideFlags: 0 - m_Inputs: [] diff --git a/GameLift-SampleGame/ProjectSettings/DynamicsManager.asset b/GameLift-SampleGame/ProjectSettings/DynamicsManager.asset deleted file mode 100644 index 8db40ea0..00000000 --- a/GameLift-SampleGame/ProjectSettings/DynamicsManager.asset +++ /dev/null @@ -1,33 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!55 &1 -PhysicsManager: - m_ObjectHideFlags: 0 - serializedVersion: 10 - m_Gravity: {x: 0, y: -9.81, z: 0} - m_DefaultMaterial: {fileID: 0} - m_BounceThreshold: 2 - m_SleepThreshold: 0.005 - m_DefaultContactOffset: 0.01 - m_DefaultSolverIterations: 6 - m_DefaultSolverVelocityIterations: 1 - m_QueriesHitBackfaces: 0 - m_QueriesHitTriggers: 1 - m_EnableAdaptiveForce: 0 - m_ClothInterCollisionDistance: 0 - m_ClothInterCollisionStiffness: 0 - m_ContactsGeneration: 1 - m_LayerCollisionMatrix: ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff - m_AutoSimulation: 1 - m_AutoSyncTransforms: 0 - m_ReuseCollisionCallbacks: 0 - m_ClothInterCollisionSettingsToggle: 0 - m_ContactPairsMode: 0 - m_BroadphaseType: 0 - m_WorldBounds: - m_Center: {x: 0, y: 0, z: 0} - m_Extent: {x: 250, y: 250, z: 250} - m_WorldSubdivisions: 8 - m_FrictionType: 0 - m_EnableEnhancedDeterminism: 0 - m_EnableUnifiedHeightmaps: 1 diff --git a/GameLift-SampleGame/ProjectSettings/EditorBuildSettings.asset b/GameLift-SampleGame/ProjectSettings/EditorBuildSettings.asset deleted file mode 100644 index bc0226bf..00000000 --- a/GameLift-SampleGame/ProjectSettings/EditorBuildSettings.asset +++ /dev/null @@ -1,14 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!1045 &1 -EditorBuildSettings: - m_ObjectHideFlags: 0 - serializedVersion: 2 - m_Scenes: - - enabled: 1 - path: Assets/Scenes/BootstrapScene.unity - guid: 8ee8fc478c95c0943a2ca26839a97aa4 - - enabled: 1 - path: Assets/Scenes/GameScene.unity - guid: 30be88f0281cb5b48a58e17861d76519 - m_configObjects: {} diff --git a/GameLift-SampleGame/ProjectSettings/EditorSettings.asset b/GameLift-SampleGame/ProjectSettings/EditorSettings.asset deleted file mode 100644 index 927bdbdd..00000000 --- a/GameLift-SampleGame/ProjectSettings/EditorSettings.asset +++ /dev/null @@ -1,23 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!159 &1 -EditorSettings: - m_ObjectHideFlags: 0 - serializedVersion: 7 - m_ExternalVersionControlSupport: Visible Meta Files - m_SerializationMode: 2 - m_LineEndingsForNewScripts: 2 - m_DefaultBehaviorMode: 0 - m_PrefabRegularEnvironment: {fileID: 0} - m_PrefabUIEnvironment: {fileID: 0} - m_SpritePackerMode: 0 - m_SpritePackerPaddingPower: 1 - m_EtcTextureCompressorBehavior: 1 - m_EtcTextureFastCompressor: 1 - m_EtcTextureNormalCompressor: 2 - m_EtcTextureBestCompressor: 4 - m_ProjectGenerationIncludedExtensions: txt;xml;fnt;cd;asmdef;rsp - m_ProjectGenerationRootNamespace: - m_CollabEditorSettings: - inProgressEnabled: 1 - m_EnableTextureStreamingInPlayMode: 1 diff --git a/GameLift-SampleGame/ProjectSettings/GraphicsSettings.asset b/GameLift-SampleGame/ProjectSettings/GraphicsSettings.asset deleted file mode 100644 index 79974606..00000000 --- a/GameLift-SampleGame/ProjectSettings/GraphicsSettings.asset +++ /dev/null @@ -1,65 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!30 &1 -GraphicsSettings: - m_ObjectHideFlags: 0 - serializedVersion: 12 - m_Deferred: - m_Mode: 1 - m_Shader: {fileID: 69, guid: 0000000000000000f000000000000000, type: 0} - m_DeferredReflections: - m_Mode: 1 - m_Shader: {fileID: 74, guid: 0000000000000000f000000000000000, type: 0} - m_ScreenSpaceShadows: - m_Mode: 1 - m_Shader: {fileID: 64, guid: 0000000000000000f000000000000000, type: 0} - m_LegacyDeferred: - m_Mode: 1 - m_Shader: {fileID: 63, guid: 0000000000000000f000000000000000, type: 0} - m_DepthNormals: - m_Mode: 1 - m_Shader: {fileID: 62, guid: 0000000000000000f000000000000000, type: 0} - m_MotionVectors: - m_Mode: 1 - m_Shader: {fileID: 75, guid: 0000000000000000f000000000000000, type: 0} - m_LightHalo: - m_Mode: 1 - m_Shader: {fileID: 105, guid: 0000000000000000f000000000000000, type: 0} - m_LensFlare: - m_Mode: 1 - m_Shader: {fileID: 102, guid: 0000000000000000f000000000000000, type: 0} - m_AlwaysIncludedShaders: - - {fileID: 7, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15104, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15105, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15106, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10753, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10770, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10783, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 16000, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 17000, guid: 0000000000000000f000000000000000, type: 0} - m_PreloadedShaders: [] - m_SpritesDefaultMaterial: {fileID: 10754, guid: 0000000000000000f000000000000000, - type: 0} - m_CustomRenderPipeline: {fileID: 0} - m_TransparencySortMode: 0 - m_TransparencySortAxis: {x: 0, y: 0, z: 1} - m_DefaultRenderingPath: 1 - m_DefaultMobileRenderingPath: 1 - m_TierSettings: [] - m_LightmapStripping: 0 - m_FogStripping: 0 - m_InstancingStripping: 0 - m_LightmapKeepPlain: 1 - m_LightmapKeepDirCombined: 1 - m_LightmapKeepDynamicPlain: 1 - m_LightmapKeepDynamicDirCombined: 1 - m_LightmapKeepShadowMask: 1 - m_LightmapKeepSubtractive: 1 - m_FogKeepLinear: 1 - m_FogKeepExp: 1 - m_FogKeepExp2: 1 - m_AlbedoSwatchInfos: [] - m_LightsUseLinearIntensity: 0 - m_LightsUseColorTemperature: 0 - m_LogWhenShaderIsCompiled: 0 diff --git a/GameLift-SampleGame/ProjectSettings/InputManager.asset b/GameLift-SampleGame/ProjectSettings/InputManager.asset deleted file mode 100644 index 17c8f538..00000000 --- a/GameLift-SampleGame/ProjectSettings/InputManager.asset +++ /dev/null @@ -1,295 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!13 &1 -InputManager: - m_ObjectHideFlags: 0 - serializedVersion: 2 - m_Axes: - - serializedVersion: 3 - m_Name: Horizontal - descriptiveName: - descriptiveNegativeName: - negativeButton: left - positiveButton: right - altNegativeButton: a - altPositiveButton: d - gravity: 3 - dead: 0.001 - sensitivity: 3 - snap: 1 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Vertical - descriptiveName: - descriptiveNegativeName: - negativeButton: down - positiveButton: up - altNegativeButton: s - altPositiveButton: w - gravity: 3 - dead: 0.001 - sensitivity: 3 - snap: 1 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire1 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left ctrl - altNegativeButton: - altPositiveButton: mouse 0 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire2 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left alt - altNegativeButton: - altPositiveButton: mouse 1 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire3 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left shift - altNegativeButton: - altPositiveButton: mouse 2 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Jump - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: space - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse X - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse Y - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 1 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse ScrollWheel - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 2 - joyNum: 0 - - serializedVersion: 3 - m_Name: Horizontal - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0.19 - sensitivity: 1 - snap: 0 - invert: 0 - type: 2 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Vertical - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0.19 - sensitivity: 1 - snap: 0 - invert: 1 - type: 2 - axis: 1 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire1 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 0 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire2 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 1 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire3 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 2 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Jump - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 3 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Submit - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: return - altNegativeButton: - altPositiveButton: joystick button 0 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Submit - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: enter - altNegativeButton: - altPositiveButton: space - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Cancel - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: escape - altNegativeButton: - altPositiveButton: joystick button 1 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 diff --git a/GameLift-SampleGame/ProjectSettings/NavMeshAreas.asset b/GameLift-SampleGame/ProjectSettings/NavMeshAreas.asset deleted file mode 100644 index 3b0b7c3d..00000000 --- a/GameLift-SampleGame/ProjectSettings/NavMeshAreas.asset +++ /dev/null @@ -1,91 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!126 &1 -NavMeshProjectSettings: - m_ObjectHideFlags: 0 - serializedVersion: 2 - areas: - - name: Walkable - cost: 1 - - name: Not Walkable - cost: 1 - - name: Jump - cost: 2 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - m_LastAgentTypeID: -887442657 - m_Settings: - - serializedVersion: 2 - agentTypeID: 0 - agentRadius: 0.5 - agentHeight: 2 - agentSlope: 45 - agentClimb: 0.75 - ledgeDropHeight: 0 - maxJumpAcrossDistance: 0 - minRegionArea: 2 - manualCellSize: 0 - cellSize: 0.16666667 - manualTileSize: 0 - tileSize: 256 - accuratePlacement: 0 - debug: - m_Flags: 0 - m_SettingNames: - - Humanoid diff --git a/GameLift-SampleGame/ProjectSettings/Physics2DSettings.asset b/GameLift-SampleGame/ProjectSettings/Physics2DSettings.asset deleted file mode 100644 index 6c5cf8a0..00000000 --- a/GameLift-SampleGame/ProjectSettings/Physics2DSettings.asset +++ /dev/null @@ -1,56 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!19 &1 -Physics2DSettings: - m_ObjectHideFlags: 0 - serializedVersion: 4 - m_Gravity: {x: 0, y: -9.81} - m_DefaultMaterial: {fileID: 0} - m_VelocityIterations: 8 - m_PositionIterations: 3 - m_VelocityThreshold: 1 - m_MaxLinearCorrection: 0.2 - m_MaxAngularCorrection: 8 - m_MaxTranslationSpeed: 100 - m_MaxRotationSpeed: 360 - m_BaumgarteScale: 0.2 - m_BaumgarteTimeOfImpactScale: 0.75 - m_TimeToSleep: 0.5 - m_LinearSleepTolerance: 0.01 - m_AngularSleepTolerance: 2 - m_DefaultContactOffset: 0.01 - m_JobOptions: - serializedVersion: 2 - useMultithreading: 0 - useConsistencySorting: 0 - m_InterpolationPosesPerJob: 100 - m_NewContactsPerJob: 30 - m_CollideContactsPerJob: 100 - m_ClearFlagsPerJob: 200 - m_ClearBodyForcesPerJob: 200 - m_SyncDiscreteFixturesPerJob: 50 - m_SyncContinuousFixturesPerJob: 50 - m_FindNearestContactsPerJob: 100 - m_UpdateTriggerContactsPerJob: 100 - m_IslandSolverCostThreshold: 100 - m_IslandSolverBodyCostScale: 1 - m_IslandSolverContactCostScale: 10 - m_IslandSolverJointCostScale: 10 - m_IslandSolverBodiesPerJob: 50 - m_IslandSolverContactsPerJob: 50 - m_AutoSimulation: 1 - m_QueriesHitTriggers: 1 - m_QueriesStartInColliders: 1 - m_CallbacksOnDisable: 1 - m_ReuseCollisionCallbacks: 0 - m_AutoSyncTransforms: 0 - m_AlwaysShowColliders: 0 - m_ShowColliderSleep: 1 - m_ShowColliderContacts: 0 - m_ShowColliderAABB: 0 - m_ContactArrowScale: 0.2 - m_ColliderAwakeColor: {r: 0.5686275, g: 0.95686275, b: 0.54509807, a: 0.7529412} - m_ColliderAsleepColor: {r: 0.5686275, g: 0.95686275, b: 0.54509807, a: 0.36078432} - m_ColliderContactColor: {r: 1, g: 0, b: 1, a: 0.6862745} - m_ColliderAABBColor: {r: 1, g: 1, b: 0, a: 0.2509804} - m_LayerCollisionMatrix: ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff diff --git a/GameLift-SampleGame/ProjectSettings/PresetManager.asset b/GameLift-SampleGame/ProjectSettings/PresetManager.asset deleted file mode 100644 index 636a595b..00000000 --- a/GameLift-SampleGame/ProjectSettings/PresetManager.asset +++ /dev/null @@ -1,6 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!1386491679 &1 -PresetManager: - m_ObjectHideFlags: 0 - m_DefaultList: [] diff --git a/GameLift-SampleGame/ProjectSettings/ProjectSettings.asset b/GameLift-SampleGame/ProjectSettings/ProjectSettings.asset deleted file mode 100644 index 9e9b82b0..00000000 --- a/GameLift-SampleGame/ProjectSettings/ProjectSettings.asset +++ /dev/null @@ -1,612 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!129 &1 -PlayerSettings: - m_ObjectHideFlags: 0 - serializedVersion: 18 - productGUID: edce954cc89f5b44abe0753e75ed8c10 - AndroidProfiler: 0 - AndroidFilterTouchesWhenObscured: 0 - AndroidEnableSustainedPerformanceMode: 0 - defaultScreenOrientation: 4 - targetDevice: 2 - useOnDemandResources: 0 - accelerometerFrequency: 60 - companyName: DefaultCompany - productName: amazon-gamelift-unity - defaultCursor: {fileID: 0} - cursorHotspot: {x: 0, y: 0} - m_SplashScreenBackgroundColor: {r: 0.13725491, g: 0.12156863, b: 0.1254902, a: 1} - m_ShowUnitySplashScreen: 1 - m_ShowUnitySplashLogo: 1 - m_SplashScreenOverlayOpacity: 1 - m_SplashScreenAnimation: 1 - m_SplashScreenLogoStyle: 1 - m_SplashScreenDrawMode: 0 - m_SplashScreenBackgroundAnimationZoom: 1 - m_SplashScreenLogoAnimationZoom: 1 - m_SplashScreenBackgroundLandscapeAspect: 1 - m_SplashScreenBackgroundPortraitAspect: 1 - m_SplashScreenBackgroundLandscapeUvs: - serializedVersion: 2 - x: 0 - y: 0 - width: 1 - height: 1 - m_SplashScreenBackgroundPortraitUvs: - serializedVersion: 2 - x: 0 - y: 0 - width: 1 - height: 1 - m_SplashScreenLogos: [] - m_VirtualRealitySplashScreen: {fileID: 0} - m_HolographicTrackingLossScreen: {fileID: 0} - defaultScreenWidth: 1024 - defaultScreenHeight: 768 - defaultScreenWidthWeb: 960 - defaultScreenHeightWeb: 600 - m_StereoRenderingPath: 0 - m_ActiveColorSpace: 0 - m_MTRendering: 1 - m_StackTraceTypes: 010000000100000001000000010000000100000001000000 - iosShowActivityIndicatorOnLoading: -1 - androidShowActivityIndicatorOnLoading: -1 - displayResolutionDialog: 1 - iosUseCustomAppBackgroundBehavior: 0 - iosAllowHTTPDownload: 1 - allowedAutorotateToPortrait: 1 - allowedAutorotateToPortraitUpsideDown: 1 - allowedAutorotateToLandscapeRight: 1 - allowedAutorotateToLandscapeLeft: 1 - useOSAutorotation: 1 - use32BitDisplayBuffer: 1 - preserveFramebufferAlpha: 0 - disableDepthAndStencilBuffers: 0 - androidStartInFullscreen: 1 - androidRenderOutsideSafeArea: 0 - androidBlitType: 0 - defaultIsNativeResolution: 1 - macRetinaSupport: 1 - runInBackground: 1 - captureSingleScreen: 0 - muteOtherAudioSources: 0 - Prepare IOS For Recording: 0 - Force IOS Speakers When Recording: 0 - deferSystemGesturesMode: 0 - hideHomeButton: 0 - submitAnalytics: 1 - usePlayerLog: 1 - bakeCollisionMeshes: 0 - forceSingleInstance: 0 - resizableWindow: 0 - useMacAppStoreValidation: 0 - macAppStoreCategory: public.app-category.games - gpuSkinning: 0 - graphicsJobs: 0 - xboxPIXTextureCapture: 0 - xboxEnableAvatar: 0 - xboxEnableKinect: 0 - xboxEnableKinectAutoTracking: 0 - xboxEnableFitness: 0 - visibleInBackground: 1 - allowFullscreenSwitch: 1 - graphicsJobMode: 0 - fullscreenMode: 1 - xboxSpeechDB: 0 - xboxEnableHeadOrientation: 0 - xboxEnableGuest: 0 - xboxEnablePIXSampling: 0 - metalFramebufferOnly: 0 - xboxOneResolution: 0 - xboxOneSResolution: 0 - xboxOneXResolution: 3 - xboxOneMonoLoggingLevel: 0 - xboxOneLoggingLevel: 1 - xboxOneDisableEsram: 0 - xboxOneEnableTypeOptimization: 0 - xboxOnePresentImmediateThreshold: 0 - switchQueueCommandMemory: 1048576 - switchQueueControlMemory: 16384 - switchQueueComputeMemory: 262144 - switchNVNShaderPoolsGranularity: 33554432 - switchNVNDefaultPoolsGranularity: 16777216 - switchNVNOtherPoolsGranularity: 16777216 - switchNVNMaxPublicTextureIDCount: 0 - switchNVNMaxPublicSamplerIDCount: 0 - vulkanEnableSetSRGBWrite: 0 - m_SupportedAspectRatios: - 4:3: 1 - 5:4: 1 - 16:10: 1 - 16:9: 1 - Others: 1 - bundleVersion: 1.0 - preloadedAssets: [] - metroInputSource: 0 - wsaTransparentSwapchain: 0 - m_HolographicPauseOnTrackingLoss: 1 - xboxOneDisableKinectGpuReservation: 0 - xboxOneEnable7thCore: 1 - isWsaHolographicRemotingEnabled: 0 - vrSettings: - cardboard: - depthFormat: 0 - enableTransitionView: 0 - daydream: - depthFormat: 0 - useSustainedPerformanceMode: 0 - enableVideoLayer: 0 - useProtectedVideoMemory: 0 - minimumSupportedHeadTracking: 0 - maximumSupportedHeadTracking: 1 - hololens: - depthFormat: 1 - depthBufferSharingEnabled: 1 - oculus: - sharedDepthBuffer: 1 - dashSupport: 1 - lowOverheadMode: 0 - protectedContext: 0 - v2Signing: 0 - enable360StereoCapture: 0 - protectGraphicsMemory: 0 - enableFrameTimingStats: 0 - useHDRDisplay: 0 - m_ColorGamuts: 00000000 - targetPixelDensity: 30 - resolutionScalingMode: 0 - androidSupportedAspectRatio: 1 - androidMaxAspectRatio: 2.1 - applicationIdentifier: {} - buildNumber: {} - AndroidBundleVersionCode: 1 - AndroidMinSdkVersion: 16 - AndroidTargetSdkVersion: 0 - AndroidPreferredInstallLocation: 1 - aotOptions: - stripEngineCode: 1 - iPhoneStrippingLevel: 0 - iPhoneScriptCallOptimization: 0 - ForceInternetPermission: 0 - ForceSDCardPermission: 0 - CreateWallpaper: 0 - APKExpansionFiles: 0 - keepLoadedShadersAlive: 0 - StripUnusedMeshComponents: 0 - VertexChannelCompressionMask: 4054 - iPhoneSdkVersion: 988 - iOSTargetOSVersionString: 9.0 - tvOSSdkVersion: 0 - tvOSRequireExtendedGameController: 0 - tvOSTargetOSVersionString: 9.0 - uIPrerenderedIcon: 0 - uIRequiresPersistentWiFi: 0 - uIRequiresFullScreen: 1 - uIStatusBarHidden: 1 - uIExitOnSuspend: 0 - uIStatusBarStyle: 0 - iPhoneSplashScreen: {fileID: 0} - iPhoneHighResSplashScreen: {fileID: 0} - iPhoneTallHighResSplashScreen: {fileID: 0} - iPhone47inSplashScreen: {fileID: 0} - iPhone55inPortraitSplashScreen: {fileID: 0} - iPhone55inLandscapeSplashScreen: {fileID: 0} - iPhone58inPortraitSplashScreen: {fileID: 0} - iPhone58inLandscapeSplashScreen: {fileID: 0} - iPadPortraitSplashScreen: {fileID: 0} - iPadHighResPortraitSplashScreen: {fileID: 0} - iPadLandscapeSplashScreen: {fileID: 0} - iPadHighResLandscapeSplashScreen: {fileID: 0} - appleTVSplashScreen: {fileID: 0} - appleTVSplashScreen2x: {fileID: 0} - tvOSSmallIconLayers: [] - tvOSSmallIconLayers2x: [] - tvOSLargeIconLayers: [] - tvOSLargeIconLayers2x: [] - tvOSTopShelfImageLayers: [] - tvOSTopShelfImageLayers2x: [] - tvOSTopShelfImageWideLayers: [] - tvOSTopShelfImageWideLayers2x: [] - iOSLaunchScreenType: 0 - iOSLaunchScreenPortrait: {fileID: 0} - iOSLaunchScreenLandscape: {fileID: 0} - iOSLaunchScreenBackgroundColor: - serializedVersion: 2 - rgba: 0 - iOSLaunchScreenFillPct: 100 - iOSLaunchScreenSize: 100 - iOSLaunchScreenCustomXibPath: - iOSLaunchScreeniPadType: 0 - iOSLaunchScreeniPadImage: {fileID: 0} - iOSLaunchScreeniPadBackgroundColor: - serializedVersion: 2 - rgba: 0 - iOSLaunchScreeniPadFillPct: 100 - iOSLaunchScreeniPadSize: 100 - iOSLaunchScreeniPadCustomXibPath: - iOSUseLaunchScreenStoryboard: 0 - iOSLaunchScreenCustomStoryboardPath: - iOSDeviceRequirements: [] - iOSURLSchemes: [] - iOSBackgroundModes: 0 - iOSMetalForceHardShadows: 0 - metalEditorSupport: 1 - metalAPIValidation: 1 - iOSRenderExtraFrameOnPause: 0 - iosCopyPluginsCodeInsteadOfSymlink: 0 - appleDeveloperTeamID: - iOSManualSigningProvisioningProfileID: - tvOSManualSigningProvisioningProfileID: - iOSManualSigningProvisioningProfileType: 0 - tvOSManualSigningProvisioningProfileType: 0 - appleEnableAutomaticSigning: 0 - iOSRequireARKit: 0 - iOSAutomaticallyDetectAndAddCapabilities: 1 - appleEnableProMotion: 0 - clonedFromGUID: 00000000000000000000000000000000 - templatePackageId: - templateDefaultScene: - AndroidTargetArchitectures: 1 - AndroidSplashScreenScale: 0 - androidSplashScreen: {fileID: 0} - AndroidKeystoreName: - AndroidKeyaliasName: - AndroidBuildApkPerCpuArchitecture: 0 - AndroidTVCompatibility: 0 - AndroidIsGame: 1 - AndroidEnableTango: 0 - androidEnableBanner: 1 - androidUseLowAccuracyLocation: 0 - m_AndroidBanners: - - width: 320 - height: 180 - banner: {fileID: 0} - androidGamepadSupportLevel: 0 - resolutionDialogBanner: {fileID: 0} - m_BuildTargetIcons: [] - m_BuildTargetPlatformIcons: [] - m_BuildTargetBatching: [] - m_BuildTargetGraphicsAPIs: [] - m_BuildTargetVRSettings: [] - m_BuildTargetEnableVuforiaSettings: [] - openGLRequireES31: 0 - openGLRequireES31AEP: 0 - m_TemplateCustomTags: {} - mobileMTRendering: - Android: 1 - iPhone: 1 - tvOS: 1 - m_BuildTargetGroupLightmapEncodingQuality: [] - m_BuildTargetGroupLightmapSettings: [] - playModeTestRunnerEnabled: 0 - runPlayModeTestAsEditModeTest: 0 - actionOnDotNetUnhandledException: 1 - enableInternalProfiler: 0 - logObjCUncaughtExceptions: 1 - enableCrashReportAPI: 0 - cameraUsageDescription: - locationUsageDescription: - microphoneUsageDescription: - switchNetLibKey: - switchSocketMemoryPoolSize: 6144 - switchSocketAllocatorPoolSize: 128 - switchSocketConcurrencyLimit: 14 - switchScreenResolutionBehavior: 2 - switchUseCPUProfiler: 0 - switchApplicationID: 0x01004b9000490000 - switchNSODependencies: - switchTitleNames_0: - switchTitleNames_1: - switchTitleNames_2: - switchTitleNames_3: - switchTitleNames_4: - switchTitleNames_5: - switchTitleNames_6: - switchTitleNames_7: - switchTitleNames_8: - switchTitleNames_9: - switchTitleNames_10: - switchTitleNames_11: - switchTitleNames_12: - switchTitleNames_13: - switchTitleNames_14: - switchTitleNames_15: - switchPublisherNames_0: - switchPublisherNames_1: - switchPublisherNames_2: - switchPublisherNames_3: - switchPublisherNames_4: - switchPublisherNames_5: - switchPublisherNames_6: - switchPublisherNames_7: - switchPublisherNames_8: - switchPublisherNames_9: - switchPublisherNames_10: - switchPublisherNames_11: - switchPublisherNames_12: - switchPublisherNames_13: - switchPublisherNames_14: - switchPublisherNames_15: - switchIcons_0: {fileID: 0} - switchIcons_1: {fileID: 0} - switchIcons_2: {fileID: 0} - switchIcons_3: {fileID: 0} - switchIcons_4: {fileID: 0} - switchIcons_5: {fileID: 0} - switchIcons_6: {fileID: 0} - switchIcons_7: {fileID: 0} - switchIcons_8: {fileID: 0} - switchIcons_9: {fileID: 0} - switchIcons_10: {fileID: 0} - switchIcons_11: {fileID: 0} - switchIcons_12: {fileID: 0} - switchIcons_13: {fileID: 0} - switchIcons_14: {fileID: 0} - switchIcons_15: {fileID: 0} - switchSmallIcons_0: {fileID: 0} - switchSmallIcons_1: {fileID: 0} - switchSmallIcons_2: {fileID: 0} - switchSmallIcons_3: {fileID: 0} - switchSmallIcons_4: {fileID: 0} - switchSmallIcons_5: {fileID: 0} - switchSmallIcons_6: {fileID: 0} - switchSmallIcons_7: {fileID: 0} - switchSmallIcons_8: {fileID: 0} - switchSmallIcons_9: {fileID: 0} - switchSmallIcons_10: {fileID: 0} - switchSmallIcons_11: {fileID: 0} - switchSmallIcons_12: {fileID: 0} - switchSmallIcons_13: {fileID: 0} - switchSmallIcons_14: {fileID: 0} - switchSmallIcons_15: {fileID: 0} - switchManualHTML: - switchAccessibleURLs: - switchLegalInformation: - switchMainThreadStackSize: 1048576 - switchPresenceGroupId: - switchLogoHandling: 0 - switchReleaseVersion: 0 - switchDisplayVersion: 1.0.0 - switchStartupUserAccount: 0 - switchTouchScreenUsage: 0 - switchSupportedLanguagesMask: 0 - switchLogoType: 0 - switchApplicationErrorCodeCategory: - switchUserAccountSaveDataSize: 0 - switchUserAccountSaveDataJournalSize: 0 - switchApplicationAttribute: 0 - switchCardSpecSize: -1 - switchCardSpecClock: -1 - switchRatingsMask: 0 - switchRatingsInt_0: 0 - switchRatingsInt_1: 0 - switchRatingsInt_2: 0 - switchRatingsInt_3: 0 - switchRatingsInt_4: 0 - switchRatingsInt_5: 0 - switchRatingsInt_6: 0 - switchRatingsInt_7: 0 - switchRatingsInt_8: 0 - switchRatingsInt_9: 0 - switchRatingsInt_10: 0 - switchRatingsInt_11: 0 - switchRatingsInt_12: 0 - switchLocalCommunicationIds_0: - switchLocalCommunicationIds_1: - switchLocalCommunicationIds_2: - switchLocalCommunicationIds_3: - switchLocalCommunicationIds_4: - switchLocalCommunicationIds_5: - switchLocalCommunicationIds_6: - switchLocalCommunicationIds_7: - switchParentalControl: 0 - switchAllowsScreenshot: 1 - switchAllowsVideoCapturing: 1 - switchAllowsRuntimeAddOnContentInstall: 0 - switchDataLossConfirmation: 0 - switchUserAccountLockEnabled: 0 - switchSystemResourceMemory: 16777216 - switchSupportedNpadStyles: 6 - switchNativeFsCacheSize: 32 - switchIsHoldTypeHorizontal: 0 - switchSupportedNpadCount: 8 - switchSocketConfigEnabled: 0 - switchTcpInitialSendBufferSize: 32 - switchTcpInitialReceiveBufferSize: 64 - switchTcpAutoSendBufferSizeMax: 256 - switchTcpAutoReceiveBufferSizeMax: 256 - switchUdpSendBufferSize: 9 - switchUdpReceiveBufferSize: 42 - switchSocketBufferEfficiency: 4 - switchSocketInitializeEnabled: 1 - switchNetworkInterfaceManagerInitializeEnabled: 1 - switchPlayerConnectionEnabled: 1 - ps4NPAgeRating: 12 - ps4NPTitleSecret: - ps4NPTrophyPackPath: - ps4ParentalLevel: 11 - ps4ContentID: ED1633-NPXX51362_00-0000000000000000 - ps4Category: 0 - ps4MasterVersion: 01.00 - ps4AppVersion: 01.00 - ps4AppType: 0 - ps4ParamSfxPath: - ps4VideoOutPixelFormat: 0 - ps4VideoOutInitialWidth: 1920 - ps4VideoOutBaseModeInitialWidth: 1920 - ps4VideoOutReprojectionRate: 60 - ps4PronunciationXMLPath: - ps4PronunciationSIGPath: - ps4BackgroundImagePath: - ps4StartupImagePath: - ps4StartupImagesFolder: - ps4IconImagesFolder: - ps4SaveDataImagePath: - ps4SdkOverride: - ps4BGMPath: - ps4ShareFilePath: - ps4ShareOverlayImagePath: - ps4PrivacyGuardImagePath: - ps4ExtraSceSysFile: - ps4NPtitleDatPath: - ps4RemotePlayKeyAssignment: -1 - ps4RemotePlayKeyMappingDir: - ps4PlayTogetherPlayerCount: 0 - ps4EnterButtonAssignment: 2 - ps4ApplicationParam1: 0 - ps4ApplicationParam2: 0 - ps4ApplicationParam3: 0 - ps4ApplicationParam4: 0 - ps4DownloadDataSize: 0 - ps4GarlicHeapSize: 2048 - ps4ProGarlicHeapSize: 2560 - ps4Passcode: frAQBc8Wsa1xVPfvJcrgRYwTiizs2trQ - ps4pnSessions: 1 - ps4pnPresence: 1 - ps4pnFriends: 1 - ps4pnGameCustomData: 1 - playerPrefsSupport: 0 - enableApplicationExit: 0 - resetTempFolder: 1 - restrictedAudioUsageRights: 0 - ps4UseResolutionFallback: 0 - ps4ReprojectionSupport: 0 - ps4UseAudio3dBackend: 0 - ps4SocialScreenEnabled: 0 - ps4ScriptOptimizationLevel: 2 - ps4Audio3dVirtualSpeakerCount: 14 - ps4attribCpuUsage: 0 - ps4PatchPkgPath: - ps4PatchLatestPkgPath: - ps4PatchChangeinfoPath: - ps4PatchDayOne: 0 - ps4attribUserManagement: 0 - ps4attribMoveSupport: 0 - ps4attrib3DSupport: 0 - ps4attribShareSupport: 0 - ps4attribExclusiveVR: 0 - ps4disableAutoHideSplash: 0 - ps4videoRecordingFeaturesUsed: 0 - ps4contentSearchFeaturesUsed: 0 - ps4CompatibilityPS5: 0 - ps4GPU800MHz: 1 - ps4attribEyeToEyeDistanceSettingVR: 0 - ps4IncludedModules: [] - monoEnv: - splashScreenBackgroundSourceLandscape: {fileID: 0} - splashScreenBackgroundSourcePortrait: {fileID: 0} - spritePackerPolicy: - webGLMemorySize: 256 - webGLExceptionSupport: 1 - webGLNameFilesAsHashes: 0 - webGLDataCaching: 1 - webGLDebugSymbols: 0 - webGLEmscriptenArgs: - webGLModulesDirectory: - webGLTemplate: APPLICATION:Default - webGLAnalyzeBuildSize: 0 - webGLUseEmbeddedResources: 0 - webGLCompressionFormat: 1 - webGLLinkerTarget: 1 - webGLThreadsSupport: 0 - scriptingDefineSymbols: - 1: - platformArchitecture: {} - scriptingBackend: {} - il2cppCompilerConfiguration: {} - managedStrippingLevel: {} - incrementalIl2cppBuild: {} - allowUnsafeCode: 0 - additionalIl2CppArgs: - scriptingRuntimeVersion: 1 - apiCompatibilityLevelPerPlatform: - Standalone: 3 - m_RenderingPath: 1 - m_MobileRenderingPath: 1 - metroPackageName: amazon-gamelift-unity - metroPackageVersion: - metroCertificatePath: - metroCertificatePassword: - metroCertificateSubject: - metroCertificateIssuer: - metroCertificateNotAfter: 0000000000000000 - metroApplicationDescription: amazon-gamelift-unity - wsaImages: {} - metroTileShortName: - metroTileShowName: 0 - metroMediumTileShowName: 0 - metroLargeTileShowName: 0 - metroWideTileShowName: 0 - metroSupportStreamingInstall: 0 - metroLastRequiredScene: 0 - metroDefaultTileSize: 1 - metroTileForegroundText: 2 - metroTileBackgroundColor: {r: 0.13333334, g: 0.17254902, b: 0.21568628, a: 0} - metroSplashScreenBackgroundColor: {r: 0.12941177, g: 0.17254902, b: 0.21568628, - a: 1} - metroSplashScreenUseBackgroundColor: 0 - platformCapabilities: {} - metroTargetDeviceFamilies: {} - metroFTAName: - metroFTAFileTypes: [] - metroProtocolName: - metroCompilationOverrides: 1 - XboxOneProductId: - XboxOneUpdateKey: - XboxOneSandboxId: - XboxOneContentId: - XboxOneTitleId: - XboxOneSCId: - XboxOneGameOsOverridePath: - XboxOnePackagingOverridePath: - XboxOneAppManifestOverridePath: - XboxOneVersion: 1.0.0.0 - XboxOnePackageEncryption: 0 - XboxOnePackageUpdateGranularity: 2 - XboxOneDescription: - XboxOneLanguage: - - enus - XboxOneCapability: [] - XboxOneGameRating: {} - XboxOneIsContentPackage: 0 - XboxOneEnableGPUVariability: 1 - XboxOneSockets: {} - XboxOneSplashScreen: {fileID: 0} - XboxOneAllowedProductIds: [] - XboxOnePersistentLocalStorageSize: 0 - XboxOneXTitleMemory: 8 - xboxOneScriptCompiler: 0 - XboxOneOverrideIdentityName: - vrEditorSettings: - daydream: - daydreamIconForeground: {fileID: 0} - daydreamIconBackground: {fileID: 0} - cloudServicesEnabled: {} - luminIcon: - m_Name: - m_ModelFolderPath: - m_PortalFolderPath: - luminCert: - m_CertPath: - m_PrivateKeyPath: - luminIsChannelApp: 0 - luminVersion: - m_VersionCode: 1 - m_VersionName: - facebookSdkVersion: - facebookAppId: - facebookCookies: 1 - facebookLogging: 1 - facebookStatus: 1 - facebookXfbml: 0 - facebookFrictionlessRequests: 1 - apiCompatibilityLevel: 6 - cloudProjectId: - framebufferDepthMemorylessMode: 0 - projectName: - organizationId: - cloudEnabled: 0 - enableNativePlatformBackendsForNewInputSystem: 0 - disableOldInputManagerSupport: 0 - legacyClampBlendShapeWeights: 0 diff --git a/GameLift-SampleGame/ProjectSettings/ProjectVersion.txt b/GameLift-SampleGame/ProjectSettings/ProjectVersion.txt deleted file mode 100644 index 35d8282d..00000000 --- a/GameLift-SampleGame/ProjectSettings/ProjectVersion.txt +++ /dev/null @@ -1,2 +0,0 @@ -m_EditorVersion: 2020.3.16f1 -m_EditorVersionWithRevision: 2020.3.16f1 (049d6eca3c44) diff --git a/GameLift-SampleGame/ProjectSettings/QualitySettings.asset b/GameLift-SampleGame/ProjectSettings/QualitySettings.asset deleted file mode 100644 index 92c2a3ce..00000000 --- a/GameLift-SampleGame/ProjectSettings/QualitySettings.asset +++ /dev/null @@ -1,229 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!47 &1 -QualitySettings: - m_ObjectHideFlags: 0 - serializedVersion: 5 - m_CurrentQuality: 5 - m_QualitySettings: - - serializedVersion: 2 - name: Very Low - pixelLightCount: 0 - shadows: 0 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 15 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 1 - textureQuality: 1 - anisotropicTextures: 0 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 0 - lodBias: 0.3 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 4 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Low - pixelLightCount: 0 - shadows: 0 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 20 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 0 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 0 - lodBias: 0.4 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 16 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Medium - pixelLightCount: 1 - shadows: 1 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 20 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 1 - lodBias: 0.7 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 64 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: High - pixelLightCount: 2 - shadows: 2 - shadowResolution: 1 - shadowProjection: 1 - shadowCascades: 2 - shadowDistance: 40 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 0 - softParticles: 0 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 1 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 256 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Very High - pixelLightCount: 3 - shadows: 2 - shadowResolution: 2 - shadowProjection: 1 - shadowCascades: 2 - shadowDistance: 70 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 4 - textureQuality: 0 - anisotropicTextures: 2 - antiAliasing: 2 - softParticles: 1 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 1.5 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 1024 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Ultra - pixelLightCount: 4 - shadows: 2 - shadowResolution: 2 - shadowProjection: 1 - shadowCascades: 4 - shadowDistance: 150 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 4 - textureQuality: 0 - anisotropicTextures: 2 - antiAliasing: 2 - softParticles: 1 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 2 - maximumLODLevel: 0 - streamingMipmapsActive: 0 - streamingMipmapsAddAllCameras: 1 - streamingMipmapsMemoryBudget: 512 - streamingMipmapsRenderersPerFrame: 512 - streamingMipmapsMaxLevelReduction: 2 - streamingMipmapsMaxFileIORequests: 1024 - particleRaycastBudget: 4096 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - asyncUploadPersistentBuffer: 1 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - m_PerPlatformDefaultQuality: - Android: 2 - Lumin: 5 - Nintendo Switch: 5 - PS4: 5 - Standalone: 5 - WebGL: 3 - Windows Store Apps: 5 - XboxOne: 5 - iPhone: 2 - tvOS: 2 diff --git a/GameLift-SampleGame/ProjectSettings/TagManager.asset b/GameLift-SampleGame/ProjectSettings/TagManager.asset deleted file mode 100644 index 1c92a784..00000000 --- a/GameLift-SampleGame/ProjectSettings/TagManager.asset +++ /dev/null @@ -1,43 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!78 &1 -TagManager: - serializedVersion: 2 - tags: [] - layers: - - Default - - TransparentFX - - Ignore Raycast - - - - Water - - UI - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - m_SortingLayers: - - name: Default - uniqueID: 0 - locked: 0 diff --git a/GameLift-SampleGame/ProjectSettings/TimeManager.asset b/GameLift-SampleGame/ProjectSettings/TimeManager.asset deleted file mode 100644 index 558a017e..00000000 --- a/GameLift-SampleGame/ProjectSettings/TimeManager.asset +++ /dev/null @@ -1,9 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!5 &1 -TimeManager: - m_ObjectHideFlags: 0 - Fixed Timestep: 0.02 - Maximum Allowed Timestep: 0.33333334 - m_TimeScale: 1 - Maximum Particle Timestep: 0.03 diff --git a/GameLift-SampleGame/ProjectSettings/UnityConnectSettings.asset b/GameLift-SampleGame/ProjectSettings/UnityConnectSettings.asset deleted file mode 100644 index fa0b1465..00000000 --- a/GameLift-SampleGame/ProjectSettings/UnityConnectSettings.asset +++ /dev/null @@ -1,34 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!310 &1 -UnityConnectSettings: - m_ObjectHideFlags: 0 - serializedVersion: 1 - m_Enabled: 0 - m_TestMode: 0 - m_EventOldUrl: https://api.uca.cloud.unity3d.com/v1/events - m_EventUrl: https://cdp.cloud.unity3d.com/v1/events - m_ConfigUrl: https://config.uca.cloud.unity3d.com - m_TestInitMode: 0 - CrashReportingSettings: - m_EventUrl: https://perf-events.cloud.unity3d.com - m_Enabled: 0 - m_LogBufferSize: 10 - m_CaptureEditorExceptions: 1 - UnityPurchasingSettings: - m_Enabled: 0 - m_TestMode: 0 - UnityAnalyticsSettings: - m_Enabled: 0 - m_TestMode: 0 - m_InitializeOnStartup: 1 - UnityAdsSettings: - m_Enabled: 0 - m_InitializeOnStartup: 1 - m_TestMode: 0 - m_IosGameId: - m_AndroidGameId: - m_GameIds: {} - m_GameId: - PerformanceReportingSettings: - m_Enabled: 0 diff --git a/GameLift-SampleGame/ProjectSettings/VFXManager.asset b/GameLift-SampleGame/ProjectSettings/VFXManager.asset deleted file mode 100644 index 6e0eaca4..00000000 --- a/GameLift-SampleGame/ProjectSettings/VFXManager.asset +++ /dev/null @@ -1,11 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!937362698 &1 -VFXManager: - m_ObjectHideFlags: 0 - m_IndirectShader: {fileID: 0} - m_CopyBufferShader: {fileID: 0} - m_SortShader: {fileID: 0} - m_RenderPipeSettingsPath: - m_FixedTimeStep: 0.016666668 - m_MaxDeltaTime: 0.05 diff --git a/GameLift-Unity/.editorconfig b/GameLift-Unity/.editorconfig deleted file mode 100644 index bd9330a2..00000000 --- a/GameLift-Unity/.editorconfig +++ /dev/null @@ -1,263 +0,0 @@ -# editorconfig.org - -# top-most EditorConfig file -root = true - -# Default settings: -# A newline ending every file -# Use 4 spaces as indentation -[*] -insert_final_newline = true -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true -charset = utf-8 -end_of_line = lf - -guidelines = 100 - -# C# files -[*.cs] - -#### .NET Coding Conventions #### - -# Organize usings -dotnet_separate_import_directive_groups = false -dotnet_sort_system_directives_first = true -file_header_template = Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\nSPDX-License-Identifier: Apache-2.0 - -# this. and Me. preferences -dotnet_style_qualification_for_event = false:suggestion -dotnet_style_qualification_for_field = false:suggestion -dotnet_style_qualification_for_method = false:suggestion -dotnet_style_qualification_for_property = false:suggestion - -# Language keywords vs BCL types preferences -dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion -dotnet_style_predefined_type_for_member_access = true:suggestion - -# Parentheses preferences -dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent -dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent -dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent -dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent - -# Modifier preferences -dotnet_style_require_accessibility_modifiers = always:warning - -# Expression-level preferences -dotnet_style_object_initializer = true:suggestion -dotnet_style_collection_initializer = true:suggestion -dotnet_style_explicit_tuple_names = true:suggestion -dotnet_style_coalesce_expression = true:suggestion -dotnet_style_null_propagation = true:suggestion -dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion -dotnet_style_prefer_inferred_tuple_names = true:suggestion -dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion -dotnet_style_prefer_auto_properties = true:suggestion -dotnet_style_prefer_conditional_expression_over_assignment = true:silent -dotnet_style_prefer_conditional_expression_over_return = true:silent - -# Code quality -dotnet_style_readonly_field = true:suggestion -dotnet_code_quality_unused_parameters = non_public:suggestion - -# Suppression preferences -dotnet_remove_unnecessary_suppression_exclusions = none - -#### C# Coding Conventions #### - -# var preferences -csharp_style_var_elsewhere = false:warning -csharp_style_var_for_built_in_types = false:warning -csharp_style_var_when_type_is_apparent = true:warning - -# Expression-bodied members -csharp_style_expression_bodied_accessors = true:silent -csharp_style_expression_bodied_methods = false:silent -csharp_style_expression_bodied_constructors = true:silent -csharp_style_expression_bodied_operators = true:silent -csharp_style_expression_bodied_properties = true:silent -csharp_style_expression_bodied_indexers = true:silent -csharp_style_expression_bodied_lambdas = true:silent -csharp_style_expression_bodied_local_functions = true:silent - -# Pattern matching preferences -csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion -csharp_style_pattern_matching_over_as_with_null_check = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_prefer_not_pattern = true:suggestion -csharp_style_prefer_pattern_matching = true:silent -csharp_style_prefer_switch_expression = true:suggestion - -# Null checking preferences -csharp_style_throw_expression = true:suggestion -csharp_style_conditional_delegate_call = true:suggestion - -# Modifier preferences -csharp_prefer_static_local_function = true:suggestion -csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning - -# Code style defaults -csharp_using_directive_placement = outside_namespace:suggestion -csharp_prefer_braces = true:silent -csharp_prefer_simple_using_statement = false:none -csharp_style_prefer_switch_expression = true:suggestion - -# Expression-level preferences -csharp_prefer_simple_default_expression = true:suggestion -csharp_style_deconstructed_variable_declaration = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_pattern_local_over_anonymous_function = true:suggestion -csharp_style_prefer_index_operator = true:suggestion -csharp_style_prefer_range_operator = true:suggestion -csharp_style_unused_value_assignment_preference = discard_variable:suggestion -csharp_style_unused_value_expression_statement_preference = discard_variable:silent - -#### C# Formatting Rules #### - -# New line preferences -csharp_new_line_before_catch = true -csharp_new_line_before_else = true -csharp_new_line_before_finally = true -csharp_new_line_before_members_in_anonymous_types = true -csharp_new_line_before_members_in_object_initializers = true -csharp_new_line_before_open_brace = all -csharp_new_line_between_query_expression_clauses = true - -# Indentation preferences -csharp_indent_block_contents = true -csharp_indent_braces = false -csharp_indent_case_contents = true -csharp_indent_case_contents_when_block = true -csharp_indent_labels = one_less_than_current -csharp_indent_switch_labels = true - -# Space preferences -csharp_space_after_cast = false -csharp_space_after_colon_in_inheritance_clause = true -csharp_space_after_comma = true -csharp_space_after_dot = false -csharp_space_after_keywords_in_control_flow_statements = true -csharp_space_after_semicolon_in_for_statement = true -csharp_space_around_binary_operators = before_and_after -csharp_space_around_declaration_statements = do_not_ignore -csharp_space_before_colon_in_inheritance_clause = true -csharp_space_before_comma = false -csharp_space_before_dot = false -csharp_space_before_open_square_brackets = false -csharp_space_before_semicolon_in_for_statement = false -csharp_space_between_empty_square_brackets = false -csharp_space_between_method_call_empty_parameter_list_parentheses = false -csharp_space_between_method_call_name_and_opening_parenthesis = false -csharp_space_between_method_call_parameter_list_parentheses = false -csharp_space_between_method_declaration_empty_parameter_list_parentheses = false -csharp_space_between_method_declaration_name_and_open_parenthesis = false -csharp_space_between_method_declaration_parameter_list_parentheses = false -csharp_space_between_parentheses = false -csharp_space_between_square_brackets = false - -# Wrapping preferences -csharp_preserve_single_line_blocks = true:none -csharp_preserve_single_line_statements = false:none - -#### Naming styles #### - -# namespaces should be pascal case -dotnet_naming_rule.namespaces_should_be_pascal_case.severity = warning -dotnet_naming_rule.namespaces_should_be_pascal_case.symbols = namespaces -dotnet_naming_rule.namespaces_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.namespaces.applicable_kinds = namespace - -# type parameters should be pascal case -dotnet_naming_rule.type_parameters_should_be_pascal_case.severity = warning -dotnet_naming_rule.type_parameters_should_be_pascal_case.symbols = type_parameter -dotnet_naming_rule.type_parameters_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.type_parameters.applicable_kinds = type_parameter - -# types should be pascal case -dotnet_naming_rule.types_should_be_pascal_case.severity = warning -dotnet_naming_rule.types_should_be_pascal_case.symbols = types -dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum -dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected -dotnet_naming_symbols.types.required_modifiers = - -# interfaces should have I prefix -dotnet_naming_rule.interface_should_be_begins_with_i_style.severity = warning -dotnet_naming_rule.interface_should_be_begins_with_i_style.symbols = interface -dotnet_naming_rule.interface_should_be_begins_with_i_style.style = begins_with_i_style -dotnet_naming_symbols.interface.applicable_kinds = interface -dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected -dotnet_naming_symbols.interface.required_modifiers = -dotnet_naming_style.begins_with_i_style.required_prefix = I -dotnet_naming_style.begins_with_i_style.required_suffix = -dotnet_naming_style.begins_with_i_style.word_separator = -dotnet_naming_style.begins_with_i_style.capitalization = pascal_case - -# non-field members should be pascal case -dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning -dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members -dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method -dotnet_naming_symbols.non_field_members.applicable_accessibilities = internal, private, protected, protected_internal, private_protected - -# public members should be pascal case -dotnet_naming_rule.public_members_should_be_pascal_case.severity = warning -dotnet_naming_rule.public_members_should_be_pascal_case.symbols = public_members -dotnet_naming_rule.public_members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.public_members.applicable_kinds = field, property, event, method -dotnet_naming_symbols.public_members.applicable_accessibilities = public -dotnet_naming_symbols.public_members.required_modifiers = - -# name all constant fields using PascalCase -dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning -dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields -dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.constant_fields.applicable_kinds = field -dotnet_naming_symbols.constant_fields.required_modifiers = const - -# static fields should have s_ prefix -dotnet_naming_rule.static_fields_should_have_prefix.severity = warning -dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields -dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style -dotnet_naming_symbols.static_fields.applicable_kinds = field -dotnet_naming_symbols.static_fields.required_modifiers = static -dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected -dotnet_naming_style.static_prefix_style.required_prefix = s_ -dotnet_naming_style.static_prefix_style.capitalization = camel_case - -# internal and private fields should be _camelCase -dotnet_naming_rule.camel_case_for_private_internal_fields.severity = warning -dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields -dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style -dotnet_naming_symbols.private_internal_fields.applicable_kinds = field -dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal - -# variables should be camel case -dotnet_naming_rule.variables_should_be_camel_case.severity = warning -dotnet_naming_rule.variables_should_be_camel_case.symbols = variables -dotnet_naming_rule.variables_should_be_camel_case.style = camel_case_style -dotnet_naming_symbols.variables.applicable_kinds = parameter, local - -# Naming styles - -dotnet_naming_style.camel_case_style.capitalization = camel_case - -dotnet_naming_style.pascal_case_style.capitalization = pascal_case - -dotnet_naming_style.camel_case_underscore_style.required_prefix = _ -dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case - -# Analyzers -dotnet_code_quality.CA1052.api_surface = private, internal -dotnet_code_quality.CA1802.api_surface = private, internal -dotnet_code_quality.CA1822.api_surface = private, internal -dotnet_code_quality.CA2208.api_surface = public - -# Shell scripts -[*.sh] -end_of_line = lf -[*.{cmd,bat}] -end_of_line = crlf diff --git a/GameLift-Unity/.gitignore b/GameLift-Unity/.gitignore deleted file mode 100644 index d9d3067c..00000000 --- a/GameLift-Unity/.gitignore +++ /dev/null @@ -1,52 +0,0 @@ -/[Ll]ibrary/ -/[Oo]utput/ -/[Ee]nvironment/ -/[Ll]ogs/ -/[Tt]emp/ -/[Oo]bj/ -/[Bb]uild/ -/[Bb]uilds/ -/UserSettings/ -/Assets/AssetStoreTools* - -# IDE cache -/.vs/ -/.vscode/ -/.localhistory/ -/.idea/ -*.vsconfig - -# Autogenerated solution and project files -ExportedObj/ -.consulo/ -*.csproj -*.unityproj -*.sln -*.suo -*.tmp -*.user -*.userprefs -*.pidb -*.booproj -*.svd -*.pdb -*.opendb -*.mdb - -# Unity3D generated meta files -*.pidb.meta -*.pdb.meta -*.mdb.meta - -# Unity3D Generated File On Crash Reports -sysinfo.txt - -# Builds -*.dll -*.apk -*.unitypackage - -GameLiftSettings.yaml - -Packages/packages-lock.json -ProjectSettings/* diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef b/GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef deleted file mode 100644 index ddea22b9..00000000 --- a/GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.Custom", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs b/GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs deleted file mode 100644 index 6e8345b0..00000000 --- a/GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs +++ /dev/null @@ -1,32 +0,0 @@ -// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// SPDX-License-Identifier: Apache-2.0 - -using System.IO; -using UnityEditor; -using UnityEngine; - -namespace AWS.GameLift.Editor -{ - public static class CustomScenarioPackageExporter - { - [MenuItem("Assets/Export Custom Scenario")] - public static void Export() - { - string[] exportedPackageAssetList = new string[] - { - "Assets\\Editor\\Custom Scenario" - }; - - string sampleFolder = @"..\GameLift-Unity\Assets\com.amazonaws.gamelift\Examples~\CustomScenario"; - - if (!Directory.Exists(sampleFolder)) - { - Directory.CreateDirectory(sampleFolder); - } - - AssetDatabase.ExportPackage(exportedPackageAssetList, Path.Combine(sampleFolder, "sample.unitypackage"), - ExportPackageOptions.Recurse); - Debug.Log(nameof(CustomScenarioPackageExporter) + " finished."); - } - } -} diff --git a/GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs b/GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs deleted file mode 100644 index 1e9d5b1d..00000000 --- a/GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs +++ /dev/null @@ -1,51 +0,0 @@ -// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// SPDX-License-Identifier: Apache-2.0 - -#if UNITY_2019_3_OR_NEWER -using System.IO; -using System.Threading; -using UnityEditor; -using UnityEngine; - -namespace AWS.GameLift.Editor -{ - public static class PluginPacker - { - private static readonly int DEFAULT_POLL_INTERVAL_IN_MS = 100; - - [MenuItem("Assets/Pack GameLift Unity Plugin")] - public static void Pack() - { - string pluginDirectory = @"..\GameLift-Unity\Assets\com.amazonaws.gamelift"; - string targetDirectory = @"..\build"; - - if (!Directory.Exists(pluginDirectory)) - { - throw new FileNotFoundException($"Unable to find the plugin folder: {pluginDirectory}"); - } - - if (!Directory.Exists(targetDirectory)) - { - Debug.Log($"Creating a build output directory at: {targetDirectory}"); - Directory.CreateDirectory(targetDirectory); - } - - // UnityEditor PackageManager Pack doc: https://docs.unity3d.com/ScriptReference/PackageManager.Client.Pack.html - Debug.Log($"Packing the plugin artifacts into package tarball at: {targetDirectory}"); - var packRequest = UnityEditor.PackageManager.Client.Pack(pluginDirectory, targetDirectory); - - while (!packRequest.IsCompleted) - { - Thread.Sleep(DEFAULT_POLL_INTERVAL_IN_MS); - } - - if (packRequest.Status != UnityEditor.PackageManager.StatusCode.Success) - { - throw new System.InvalidOperationException($"Failed to pack package tarball. Error: {packRequest.Error.message}"); - } - - Debug.Log($"Sucessfully packed plugin artifacts into package tarball at: {packRequest.Result.tarballPath}"); - } - } -} -#endif diff --git a/GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs b/GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs deleted file mode 100644 index 7fc98964..00000000 --- a/GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs +++ /dev/null @@ -1,138 +0,0 @@ -// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// SPDX-License-Identifier: Apache-2.0 - -using System.Collections.Generic; -using System.Threading.Tasks; -using AmazonGameLift.Editor; -using AmazonGameLiftPlugin.Core.DeploymentManagement.Models; -using UnityEditor; -using Debug = UnityEngine.Debug; - -namespace AWS.GameLift.Editor -{ - public static class StackUpdateDialogTest - { - [MenuItem("GameLift/Testing/Unity Dialog")] - public static void RunUnity() - { - EditorUtility.DisplayDialog("Place Selection On Surface?", - "Are you sure you want to place on the surface?", "Place", "Do Not Place"); - } - - [MenuItem("GameLift/Testing/StackUpdateDialog (Removal changes)")] - public static async void RunRemoval() - { - IEnumerable changes = new[] - { - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "RestApi", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - new Change() - { - Action = "Remove", - LogicalId = "UserPool", - ResourceType = "AWS::Cognito::UserPool" - } - }; - await RunStackUpdateTest(changes); - } - - private static async Task RunStackUpdateTest(IEnumerable changes) - { - var changeSet = new ConfirmChangesRequest - { - Region = "eu-west-1", - StackId = "StackId", - ChangeSetId = "ChangeSetId", - Changes = changes, - }; - StackUpdateDialog dialog = EditorWindow.GetWindow(); - bool result = await dialog.SetUp(new StackUpdateModel(changeSet, string.Empty)); - Debug.Log($"Result: {result}"); - } - - [MenuItem("GameLift/Testing/StackUpdateDialog (No removal changes)")] - public static async void Run() - { - IEnumerable changes = new[] - { - new Change() - { - Action = "Add", - LogicalId = "RestApi2", - ResourceType = "AWS::ApiGateway::RestApi" - }, - }; - await RunStackUpdateTest(changes); - } - } -} diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift.meta deleted file mode 100644 index 73651469..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: f9988467b1bef9a4b89d76d796777100 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef deleted file mode 100644 index 6073e141..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/AmazonGameLiftPlugin.Editor.asmdef +++ /dev/null @@ -1,19 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.Editor", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI", - "AmazonGameLiftPlugin.Runtime" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef deleted file mode 100644 index 3cabb25e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/CoreAPI/AmazonGameLiftPlugin.EditorCoreAPI.asmdef +++ /dev/null @@ -1,17 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.EditorCoreAPI", - "references": [], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll", - "Newtonsoft.Json.dll" - ], - "autoReferenced": false, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef deleted file mode 100644 index eee94714..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario1_auth_only/AmazonGameLiftPlugin.AuthOnly.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.AuthOnly", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef deleted file mode 100644 index 6e1371b2..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario2_single_fleet/AmazonGameLiftPlugin.SingleFleet.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.SingleFleet", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef deleted file mode 100644 index c27c46c6..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario3_mrf_queue/AmazonGameLiftPlugin.MrfQueue.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.MrfQueue", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef deleted file mode 100644 index 2d5ba69c..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario4_spot_fleets/AmazonGameLiftPlugin.SpotFleets.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.SpotFleets", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef deleted file mode 100644 index a98a0ce8..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/CloudFormation/scenario5_flexmatch/AmazonGameLiftPlugin.FlexMatch.asmdef +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.FlexMatch", - "references": [ - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/.gitignore b/GameLift-Unity/Assets/com.amazonaws.gamelift/Editor/Resources/Images/Light/.gitignore deleted file mode 100644 index e69de29b..00000000 diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.dll.meta deleted file mode 100644 index c7911e03..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 722ad8ef04c625a4baabb4e61a021d23 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml deleted file mode 100644 index 1816671a..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CloudFormation.xml +++ /dev/null @@ -1,27856 +0,0 @@ - - - - AWSSDK.CloudFormation - - - - - Custom pipeline handler to pass an empty string NotificationARNs request property with collection is empty. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Set NotificationARNs to empty if the collection is empty before continuing on in the pipeline. - - - - - - Service metadata for Amazon CloudFormation service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The input for UpdateStack action. - - - Container for the parameters to the UpdateStack operation. - Updates a stack as specified in the template. After the call completes successfully, - the stack update starts. You can check the status of the stack via the DescribeStacks - action. - - - - To get a copy of the template for an existing stack, you can use the GetTemplate - action. - - - - For more information about creating an update template, updating a stack, and monitoring - the progress of the update, see Updating - a Stack. - - - - - - Default Constructor - - - - - Gets and sets the property Capabilities. - - In some cases, you must explicitly acknowledge that your stack template contains certain - capabilities in order for AWS CloudFormation to update the stack. - -
  • - - CAPABILITY_IAM and CAPABILITY_NAMED_IAM - - - - Some stack templates might include resources that can affect permissions in your AWS - account; for example, by creating new AWS Identity and Access Management (IAM) users. - For those stacks, you must explicitly acknowledge this by specifying one of these - capabilities. - - - - The following IAM resources require you to specify either the CAPABILITY_IAM - or CAPABILITY_NAMED_IAM capability. - -
    • - - If you have IAM resources, you can specify either capability. - -
    • - - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. - - -
    • - - If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities - error. - -
    - - If your stack template contains these resources, we recommend that you review all - permissions associated with them and edit their permissions if necessary. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - -
  • - - CAPABILITY_AUTO_EXPAND - - - - Some template contain macros. Macros perform custom processing on templates; this - can include simple actions like find-and-replace operations, all the way to extensive - transformations of entire templates. Because of this, users typically create a change - set from the processed template, so that they can review the changes resulting from - the macros before actually updating the stack. If your stack template contains one - or more macros, and you choose to update a stack directly from the processed template, - without first reviewing the resulting changes in a change set, you must acknowledge - this capability. This includes the AWS::Include - and AWS::Serverless - transforms, which are macros hosted by AWS CloudFormation. - - - - If you want to update a stack from a stack template that contains macros and - nested stacks, you must update the stack directly from the template using this capability. - - - - You should only update stacks directly from a stack template that contains macros - if you know what processing the macro performs. - - - - Each macro relies on an underlying Lambda service function for processing stack templates. - Be aware that the Lambda function owner can update the function operation without - AWS CloudFormation being notified. - - - - For more information, see Using - AWS CloudFormation Macros to Perform Custom Processing on Templates. - -
- - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this UpdateStack request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to update a stack with the same name. You might retry UpdateStack requests - to ensure that AWS CloudFormation successfully received them. - - - - All events triggered by a given stack operation are assigned the same client request - token, which you can use to track operations. For example, if you execute a CreateStack - operation with the token token1, then all the StackEvents - generated by that operation will have ClientRequestToken set as token1. - - - - In the console, stack operations display the client request token on the Events tab. - Stack operations that are initiated from the console use the token format Console-StackOperation-ID, - which helps you easily identify the stack operation . For example, if you create a - stack using the console, each stack event would be assigned the same token in the - following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. - - - - - - - Gets and sets the property NotificationARNs. - - Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation - associates with the stack. Specify an empty list to remove all notification topics. - - - - - - Gets and sets the property Parameters. - - A list of Parameter structures that specify input parameters for the - stack. For more information, see the Parameter - data type. - - - - - - Gets and sets the property ResourceTypes. - - The template resource types that you have permissions to work with for this update - stack action, such as AWS::EC2::Instance, AWS::EC2::*, or - Custom::MyCustomInstance. - - - - If the list of resource types doesn't include a resource that you're updating, the - stack update fails. By default, AWS CloudFormation grants permissions to all resource - types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific - condition keys in IAM policies. For more information, see Controlling - Access with AWS Identity and Access Management. - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's - credentials to make calls on your behalf. AWS CloudFormation always uses this role - for all future operations on the stack. As long as users have permission to operate - on the stack, AWS CloudFormation uses this role even if the users don't have permission - to pass it. Ensure that the role grants least privilege. - - - - If you don't specify a value, AWS CloudFormation uses the role that was previously - associated with the stack. If no role is available, AWS CloudFormation uses a temporary - session that is generated from your user credentials. - - - - - - Gets and sets the property RollbackConfiguration. - - The rollback triggers for AWS CloudFormation to monitor during stack creation and - updating operations, and for the specified monitoring period afterwards. - - - - - - Gets and sets the property StackName. - - The name or unique stack ID of the stack to update. - - - - - - Gets and sets the property StackPolicyBody. - - Structure containing a new stack policy body. You can specify either the StackPolicyBody - or the StackPolicyURL parameter, but not both. - - - - You might update the stack policy, for example, in order to protect a new resource - that you created during a stack update. If you do not specify a stack policy, the - current policy that is associated with the stack is unchanged. - - - - - - Gets and sets the property StackPolicyDuringUpdateBody. - - Structure containing the temporary overriding stack policy body. You can specify either - the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL - parameter, but not both. - - - - If you want to update protected resources, specify a temporary overriding stack policy - during this update. If you do not specify a stack policy, the current policy that - is associated with the stack will be used. - - - - - - Gets and sets the property StackPolicyDuringUpdateURL. - - Location of a file containing the temporary overriding stack policy. The URL must - point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the - stack. You can specify either the StackPolicyDuringUpdateBody or the - StackPolicyDuringUpdateURL parameter, but not both. - - - - If you want to update protected resources, specify a temporary overriding stack policy - during this update. If you do not specify a stack policy, the current policy that - is associated with the stack will be used. - - - - - - Gets and sets the property StackPolicyURL. - - Location of a file containing the updated stack policy. The URL must point to a policy - (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can - specify either the StackPolicyBody or the StackPolicyURL - parameter, but not both. - - - - You might update the stack policy, for example, in order to protect a new resource - that you created during a stack update. If you do not specify a stack policy, the - current policy that is associated with the stack is unchanged. - - - - - - Gets and sets the property Tags. - - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these - tags to supported resources in the stack. You can specify a maximum number of 50 tags. - - - - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's - tags. If you specify an empty value, AWS CloudFormation removes all associated tags. - - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body with a minimum length of 1 byte and a maximum - length of 51,200 bytes. (For more information, go to Template - Anatomy in the AWS CloudFormation User Guide.) - - - - Conditional: You must specify only one of the following parameters: TemplateBody, - TemplateURL, or set the UsePreviousTemplate to true. - - - - - - Gets and sets the property TemplateURL. - - Location of file containing the template body. The URL must point to a template that - is located in an Amazon S3 bucket or a Systems Manager document. For more information, - go to Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify only one of the following parameters: TemplateBody, - TemplateURL, or set the UsePreviousTemplate to true. - - - - - - Gets and sets the property UsePreviousTemplate. - - Reuse the existing template that is associated with the stack that you are updating. - - - - Conditional: You must specify only one of the following parameters: TemplateBody, - TemplateURL, or set the UsePreviousTemplate to true. - - - - - - Structure that contains the results of the account gate function which AWS CloudFormation - invokes, if present, before proceeding with a stack set operation in an account and - Region. - - - - For each account and Region, AWS CloudFormation lets you specify a Lamdba function - that encapsulates any requirements that must be met before CloudFormation can proceed - with a stack set operation in that account and Region. CloudFormation invokes the - function each time a stack set operation is requested for that account and Region; - if the function returns FAILED, CloudFormation cancels the operation - in that account and Region, and sets the stack set operation result status for that - account and Region to FAILED. - - - - For more information, see Configuring - a target account gate. - - - - - - Gets and sets the property Status. - - The status of the account gate function. - -
  • - - SUCCEEDED: The account gate function has determined that the account - and Region passes any requirements for a stack set operation to occur. AWS CloudFormation - proceeds with the stack operation in that account and Region. - -
  • - - FAILED: The account gate function has determined that the account and - Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation - cancels the stack set operation in that account and Region, and sets the stack set - operation result status for that account and Region to FAILED. - -
  • - - SKIPPED: AWS CloudFormation has skipped calling the account gate function - for this account and Region, for one of the following reasons: - -
    • - - An account gate function has not been specified for the account and Region. AWS CloudFormation - proceeds with the stack set operation in this account and Region. - -
    • - - The AWSCloudFormationStackSetExecutionRole of the stack set adminstration - account lacks permissions to invoke the function. AWS CloudFormation proceeds with - the stack set operation in this account and Region. - -
    • - - Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation - skips the stack set operation in this account and Region. - -
- - - - - Gets and sets the property StatusReason. - - The reason for the account gate status assigned to this account and Region for the - stack set operation. - - - - - - The AccountLimit data type. - - - - CloudFormation has the following limits per account: - -
  • - - Number of concurrent resources - -
  • - - Number of stacks - -
  • - - Number of stack outputs - -
- - For more information about these account limits, and other CloudFormation limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property Name. - - The name of the account limit. - - - - Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit - - - - - - - Gets and sets the property Value. - - The value that is associated with the account limit name. - - - - - - Container for the parameters to the ActivateType operation. - Activates a public third-party extension, making it available for use in stack templates. - For more information, see Using - public extensions in the CloudFormation User Guide. - - - - Once you have activated a public third-party extension in your account and region, - use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - - - Gets and sets the property AutoUpdate. - - Whether to automatically update the extension in this account and region when a new - minor version is published by the extension publisher. Major versions released - by the publisher must be manually updated. - - - - The default is true. - - - - - - Gets and sets the property ExecutionRoleArn. - - The name of the IAM execution role to use to activate the extension. - - - - - - Gets and sets the property LoggingConfig. - - - - - Gets and sets the property MajorVersion. - - The major version of this extension you want to activate, if multiple major versions - are available. The default is the latest major version. CloudFormation uses the latest - available minor version of the major version selected. - - - - You can specify MajorVersion or VersionBump, but not both. - - - - - - Gets and sets the property PublicTypeArn. - - The Amazon Resource Number (ARN) of the public extension. - - - - Conditional: You must specify PublicTypeArn, or TypeName, - Type, and PublisherId. - - - - - - Gets and sets the property PublisherId. - - The ID of the extension publisher. - - - - Conditional: You must specify PublicTypeArn, or TypeName, - Type, and PublisherId. - - - - - - Gets and sets the property Type. - - The extension type. - - - - Conditional: You must specify PublicTypeArn, or TypeName, - Type, and PublisherId. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify PublicTypeArn, or TypeName, - Type, and PublisherId. - - - - - - Gets and sets the property TypeNameAlias. - - An alias to assign to the public extension, in this account and region. If you specify - an alias for the extension, CloudFormation treats the alias as the extension type - name within this account and region. You must use the alias to refer to the extension - in your templates, API calls, and CloudFormation console. - - - - An extension alias must be unique within a given account and region. You can activate - the same public resource multiple times in the same account and region, using different - type name aliases. - - - - - - Gets and sets the property VersionBump. - - Manually updates a previously-activated type to a new major or minor version, if available. - You can also use this parameter to update the value of AutoUpdate. - -
  • - - MAJOR: CloudFormation updates the extension to the newest major version, - if one is available. - -
  • - - MINOR: CloudFormation updates the extension to the newest minor version, - if one is available. - -
- - - - - This is the response object from the ActivateType operation. - - - - - Gets and sets the property Arn. - - The Amazon Resource Number (ARN) of the activated extension, in this account and region. - - - - - - The resource with the name requested already exists. - - - - - Constructs a new AlreadyExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of AlreadyExistsException - - - - - - - Construct instance of AlreadyExistsException - - - - - - Construct instance of AlreadyExistsException - - - - - - - - - - - Construct instance of AlreadyExistsException - - - - - - - - - - Constructs a new instance of the AlreadyExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - [Service-managed permissions] Describes whether StackSets automatically deploys to - AWS Organizations accounts that are added to a target organization or organizational - unit (OU). - - - - - Gets and sets the property Enabled. - - If set to true, StackSets automatically deploys additional stack instances - to AWS Organizations accounts that are added to a target organization or organizational - unit (OU) in the specified Regions. If an account is removed from a target organization - or OU, StackSets deletes stack instances from the account in the specified Regions. - - - - - - Gets and sets the property RetainStacksOnAccountRemoval. - - If set to true, stack resources are retained when an account is removed - from a target organization or OU. If set to false, stack resources are - deleted. Specify only if Enabled is set to True. - - - - - - Detailed information concerning an error generated during the setting of configuration - data for a CloudFormation extension. - - - - - Gets and sets the property ErrorCode. - - The error code. - - - - - - Gets and sets the property ErrorMessage. - - The error message. - - - - - - Gets and sets the property TypeConfigurationIdentifier. - - - - - Container for the parameters to the BatchDescribeTypeConfigurations operation. - Returns configuration data for the specified CloudFormation extensions, from the CloudFormation - registry for the account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - - - Gets and sets the property TypeConfigurationIdentifiers. - - The list of identifiers for the desired extension configurations. - - - - - - This is the response object from the BatchDescribeTypeConfigurations operation. - - - - - Gets and sets the property Errors. - - A list of information concerning any errors generated during the setting of the specified - configurations. - - - - - - Gets and sets the property TypeConfigurations. - - A list of any of the specified extension configurations from the CloudFormation registry. - - - - - - Gets and sets the property UnprocessedTypeConfigurations. - - A list of any of the specified extension configurations that CloudFormation could - not process for any reason. - - - - - - Container for the parameters to the CancelUpdateStack operation. - Cancels an update on the specified stack. If the call completes successfully, the - stack rolls back the update and reverts to the previous stack configuration. - - - - You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. - - - - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this CancelUpdateStack request. Specify this - token if you plan to retry requests so that AWS CloudFormation knows that you're not - attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack - requests to ensure that AWS CloudFormation successfully received them. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack. - - - - - - This is the response object from the CancelUpdateStack operation. - - - - - An error occurred during a CloudFormation registry operation. - - - - - Constructs a new CFNRegistryException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of CFNRegistryException - - - - - - - Construct instance of CFNRegistryException - - - - - - Construct instance of CFNRegistryException - - - - - - - - - - - Construct instance of CFNRegistryException - - - - - - - - - - Constructs a new instance of the CFNRegistryException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The Change structure describes the changes AWS CloudFormation will perform - if you execute the change set. - - - - - Gets and sets the property ResourceChange. - - A ResourceChange structure that describes the resource and action that - AWS CloudFormation will perform. - - - - - - Gets and sets the property Type. - - The type of entity that AWS CloudFormation changes. Currently, the only entity type - is Resource. - - - - - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - - - - Constructs a new ChangeSetNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ChangeSetNotFoundException - - - - - - - Construct instance of ChangeSetNotFoundException - - - - - - Construct instance of ChangeSetNotFoundException - - - - - - - - - - - Construct instance of ChangeSetNotFoundException - - - - - - - - - - Constructs a new instance of the ChangeSetNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The ChangeSetSummary structure describes a change set, its status, and - the stack with which it's associated. - - - - - Gets and sets the property ChangeSetId. - - The ID of the change set. - - - - - - Gets and sets the property ChangeSetName. - - The name of the change set. - - - - - - Gets and sets the property CreationTime. - - The start time when the change set was created, in UTC. - - - - - - Gets and sets the property Description. - - Descriptive information about the change set. - - - - - - Gets and sets the property ExecutionStatus. - - If the change set execution status is AVAILABLE, you can execute the - change set. If you can’t execute the change set, the status indicates why. For example, - a change set might be in an UNAVAILABLE state because AWS CloudFormation - is still creating it or in an OBSOLETE state because the stack was already - updated. - - - - - - Gets and sets the property IncludeNestedStacks. - - Specifies the current setting of IncludeNestedStacks for the change set. - - - - - - Gets and sets the property ParentChangeSetId. - - The parent change set ID. - - - - - - Gets and sets the property RootChangeSetId. - - The root change set ID. - - - - - - Gets and sets the property StackId. - - The ID of the stack with which the change set is associated. - - - - - - Gets and sets the property StackName. - - The name of the stack with which the change set is associated. - - - - - - Gets and sets the property Status. - - The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, - or FAILED. - - - - - - Gets and sets the property StatusReason. - - A description of the change set's status. For example, if your change set is in the - FAILED state, AWS CloudFormation shows the error message. - - - - - - Container for the parameters to the ContinueUpdateRollback operation. - For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues - rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the - cause of the failure, you can manually - fix the error and continue the rollback. By continuing the rollback, you can return - your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - then try to update the stack again. - - - - A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation - cannot roll back all changes after a failed stack update. For example, you might have - a stack that is rolling back to an old database instance that was deleted outside - of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, - it assumes that the database instance still exists and attempts to roll back to it, - causing the update rollback to fail. - - - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this ContinueUpdateRollback request. Specify - this token if you plan to retry requests so that AWS CloudFormation knows that you're - not attempting to continue the rollback to a stack with the same name. You might retry - ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully - received them. - - - - - - Gets and sets the property ResourcesToSkip. - - A list of the logical IDs of the resources that AWS CloudFormation skips during the - continue update rollback operation. You can specify only resources that are in the - UPDATE_FAILED state because a rollback failed. You can't specify resources - that are in the UPDATE_FAILED state for other reasons, for example, because - an update was cancelled. To check why a resource update failed, use the DescribeStackResources - action, and view the resource status reason. - - - - Specify this property to skip rolling back resources that AWS CloudFormation can't - successfully roll back. We recommend that you - troubleshoot resources before skipping them. AWS CloudFormation sets the status - of the specified resources to UPDATE_COMPLETE and continues to roll back - the stack. After the rollback is complete, the state of the skipped resources will - be inconsistent with the state of the resources in the stack template. Before performing - another stack update, you must update the stack or resources to be consistent with - each other. If you don't, subsequent stack updates might fail, and the stack will - become unrecoverable. - - - - Specify the minimum number of resources required to successfully roll back your stack. - For example, a failed resource update might cause dependent resources to fail. In - this case, it might not be necessary to skip the dependent resources. - - - - To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. - If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) - in the ResourcesToSkip list, then its corresponding embedded stack must - be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, - or DELETE_FAILED. - - - - Don't confuse a child stack's name with its corresponding logical ID defined in the - parent stack. For an example of a continue update rollback operation with nested stacks, - see Using - ResourcesToSkip to recover a nested stacks hierarchy. - - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the - role's credentials to make calls on your behalf. AWS CloudFormation always uses this - role for all future operations on the stack. As long as users have permission to operate - on the stack, AWS CloudFormation uses this role even if the users don't have permission - to pass it. Ensure that the role grants least privilege. - - - - If you don't specify a value, AWS CloudFormation uses the role that was previously - associated with the stack. If no role is available, AWS CloudFormation uses a temporary - session that is generated from your user credentials. - - - - - - Gets and sets the property StackName. - - The name or the unique ID of the stack that you want to continue rolling back. - - - - Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack - resource). Instead, use this operation on the parent stack (the stack that contains - the AWS::CloudFormation::Stack resource). - - - - - - - The output for a ContinueUpdateRollback action. - - - - - Container for the parameters to the CreateChangeSet operation. - Creates a list of changes that will be applied to a stack so that you can review the - changes before executing them. You can create a change set for a stack that doesn't - exist or an existing stack. If you create a change set for a stack that doesn't exist, - the change set shows all of the resources that AWS CloudFormation will create. If - you create a change set for an existing stack, AWS CloudFormation compares the stack's - information with the information that you submit in the change set and lists the differences. - Use change sets to understand which resources AWS CloudFormation will create or change, - and how it will change resources in an existing stack, before you create or update - a stack. - - - - To create a change set for a stack that doesn't exist, for the ChangeSetType - parameter, specify CREATE. To create a change set for an existing stack, - specify UPDATE for the ChangeSetType parameter. To create - a change set for an import operation, specify IMPORT for the ChangeSetType - parameter. After the CreateChangeSet call successfully completes, AWS - CloudFormation starts creating the change set. To check the status of the change set - or to review it, use the DescribeChangeSet action. - - - - When you are satisfied with the changes the change set will make, execute the change - set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes - until you execute the change set. - - - - To create a change set for the entire stack hierachy, set IncludeNestedStacks - to True. - - - - - - Gets and sets the property Capabilities. - - In some cases, you must explicitly acknowledge that your stack template contains certain - capabilities in order for AWS CloudFormation to create the stack. - -
  • - - CAPABILITY_IAM and CAPABILITY_NAMED_IAM - - - - Some stack templates might include resources that can affect permissions in your AWS - account; for example, by creating new AWS Identity and Access Management (IAM) users. - For those stacks, you must explicitly acknowledge this by specifying one of these - capabilities. - - - - The following IAM resources require you to specify either the CAPABILITY_IAM - or CAPABILITY_NAMED_IAM capability. - -
    • - - If you have IAM resources, you can specify either capability. - -
    • - - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. - - -
    • - - If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities - error. - -
    - - If your stack template contains these resources, we recommend that you review all - permissions associated with them and edit their permissions if necessary. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - -
  • - - CAPABILITY_AUTO_EXPAND - - - - Some template contain macros. Macros perform custom processing on templates; this - can include simple actions like find-and-replace operations, all the way to extensive - transformations of entire templates. Because of this, users typically create a change - set from the processed template, so that they can review the changes resulting from - the macros before actually creating the stack. If your stack template contains one - or more macros, and you choose to create a stack directly from the processed template, - without first reviewing the resulting changes in a change set, you must acknowledge - this capability. This includes the AWS::Include - and AWS::Serverless - transforms, which are macros hosted by AWS CloudFormation. - - - - This capacity does not apply to creating change sets, and specifying it when creating - change sets has no effect. - - - - If you want to create a stack from a stack template that contains macros and - nested stacks, you must create or update the stack directly from the template using - the CreateStack or UpdateStack action, and specifying this capability. - - - - For more information on macros, see Using - AWS CloudFormation Macros to Perform Custom Processing on Templates. - -
- - - - - Gets and sets the property ChangeSetName. - - The name of the change set. The name must be unique among all change sets that are - associated with the specified stack. - - - - A change set name can contain only alphanumeric, case sensitive characters and hyphens. - It must start with an alphabetic character and cannot exceed 128 characters. - - - - - - Gets and sets the property ChangeSetType. - - The type of change set operation. To create a change set for a new stack, specify - CREATE. To create a change set for an existing stack, specify UPDATE. - To create a change set for an import operation, specify IMPORT. - - - - If you create a change set for a new stack, AWS Cloudformation creates a stack with - a unique stack ID, but no template or resources. The stack will be in the - REVIEW_IN_PROGRESS state until you execute the change set. - - - - By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE - type to create a change set for a new stack or the CREATE type to create - a change set for an existing stack. - - - - - - Gets and sets the property ClientToken. - - A unique identifier for this CreateChangeSet request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to create another change set with the same name. You might retry CreateChangeSet - requests to ensure that AWS CloudFormation successfully received them. - - - - - - Gets and sets the property Description. - - A description to help you identify this change set. - - - - - - Gets and sets the property IncludeNestedStacks. - - Creates a change set for the all nested stacks specified in the template. The default - behavior of this action is set to False. To include nested sets in a - change set, specify True. - - - - - - Gets and sets the property NotificationARNs. - - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) - topics that AWS CloudFormation associates with the stack. To remove all associated - notification topics, specify an empty list. - - - - - - Gets and sets the property Parameters. - - A list of Parameter structures that specify input parameters for the - change set. For more information, see the Parameter data type. - - - - - - Gets and sets the property ResourcesToImport. - - The resources to import into your stack. - - - - - - Gets and sets the property ResourceTypes. - - The template resource types that you have permissions to work with if you execute - this change set, such as AWS::EC2::Instance, AWS::EC2::*, - or Custom::MyCustomInstance. - - - - If the list of resource types doesn't include a resource type that you're updating, - the stack update fails. By default, AWS CloudFormation grants permissions to all resource - types. AWS Identity and Access Management (IAM) uses this parameter for condition - keys in IAM policies for AWS CloudFormation. For more information, see Controlling - Access with AWS Identity and Access Management in the AWS CloudFormation User - Guide. - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that AWS CloudFormation assumes when executing the change set. AWS CloudFormation - uses the role's credentials to make calls on your behalf. AWS CloudFormation uses - this role for all future operations on the stack. As long as users have permission - to operate on the stack, AWS CloudFormation uses this role even if the users don't - have permission to pass it. Ensure that the role grants least privilege. - - - - If you don't specify a value, AWS CloudFormation uses the role that was previously - associated with the stack. If no role is available, AWS CloudFormation uses a temporary - session that is generated from your user credentials. - - - - - - Gets and sets the property RollbackConfiguration. - - The rollback triggers for AWS CloudFormation to monitor during stack creation and - updating operations, and for the specified monitoring period afterwards. - - - - - - Gets and sets the property StackName. - - The name or the unique ID of the stack for which you are creating a change set. AWS - CloudFormation generates the change set by comparing this stack's information with - the information that you submit, such as a modified template or different parameter - input values. - - - - - - Gets and sets the property Tags. - - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these - tags to resources in the stack. You can specify a maximum of 50 tags. - - - - - - Gets and sets the property TemplateBody. - - A structure that contains the body of the revised template, with a minimum length - of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change - set by comparing this template with the template of the stack that you specified. - - - - Conditional: You must specify only TemplateBody or TemplateURL. - - - - - - Gets and sets the property TemplateURL. - - The location of the file that contains the revised template. The URL must point to - a template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems - Manager document. AWS CloudFormation generates the change set by comparing this template - with the stack that you specified. - - - - Conditional: You must specify only TemplateBody or TemplateURL. - - - - - - Gets and sets the property UsePreviousTemplate. - - Whether to reuse the template that is associated with the stack to create the change - set. - - - - - - The output for the CreateChangeSet action. - - - - - Gets and sets the property Id. - - The Amazon Resource Name (ARN) of the change set. - - - - - - Gets and sets the property StackId. - - The unique ID of the stack. - - - - - - The specified resource exists, but has been changed. - - - - - Constructs a new CreatedButModifiedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of CreatedButModifiedException - - - - - - - Construct instance of CreatedButModifiedException - - - - - - Construct instance of CreatedButModifiedException - - - - - - - - - - - Construct instance of CreatedButModifiedException - - - - - - - - - - Constructs a new instance of the CreatedButModifiedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the CreateStackInstances operation. - Creates stack instances for the specified accounts, within the specified Regions. - A stack instance refers to a stack in a specific account and Region. You must specify - at least one value for either Accounts or DeploymentTargets, - and you must specify at least one value for Regions. - - - - - Gets and sets the property Accounts. - - [Self-managed permissions] The names of one or more AWS accounts that you want to - create stack instances in the specified Region(s) for. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property DeploymentTargets. - - [Service-managed permissions] The AWS Organizations accounts for which to create stack - instances in the specified Regions. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation - performs the stack set operation only once, even if you retry the request multiple - times. You might retry stack set operation requests to ensure that AWS CloudFormation - successfully received them. - - - - If you don't specify an operation ID, the SDK generates one automatically. - - - - Repeating this stack set operation with a new operation ID retries all stack instances - whose status is OUTDATED. - - - - - - Gets and sets the property OperationPreferences. - - Preferences for how AWS CloudFormation performs this stack set operation. - - - - - - Gets and sets the property ParameterOverrides. - - A list of stack set parameters whose values you want to override in the selected stack - instances. - - - - Any overridden parameter values will be applied to all stack instances in the specified - accounts and Regions. When specifying parameters and their values, be aware of how - AWS CloudFormation sets parameter values during stack instance operations: - -
  • - - To override the current value for a parameter, include the parameter and specify its - value. - -
  • - - To leave a parameter set to its present value, you can do one of the following: - -
    • - - Do not include the parameter in the list. - -
    • - - Include the parameter and specify UsePreviousValue as true. - (You cannot specify both a value and set UsePreviousValue to true.) - -
  • - - To set all overridden parameter back to the values specified in the stack set, specify - a parameter list but do not include any parameters. - -
  • - - To leave all parameters set to their present values, do not specify this property - at all. - -
- - During stack set updates, any parameter values overridden for a stack instance are - not updated, but retain their overridden value. - - - - You can only override the parameter values that are specified in the stack - set; to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. - - - - - - Gets and sets the property Regions. - - The names of one or more Regions where you want to create stack instances using the - specified AWS account(s). - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to create stack instances from. - - - - - - This is the response object from the CreateStackInstances operation. - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - - - Container for the parameters to the CreateStack operation. - Creates a stack as specified in the template. After the call completes successfully, - the stack creation starts. You can check the status of the stack via the DescribeStacks - API. - - - - - Gets and sets the property Capabilities. - - In some cases, you must explicitly acknowledge that your stack template contains certain - capabilities in order for AWS CloudFormation to create the stack. - -
  • - - CAPABILITY_IAM and CAPABILITY_NAMED_IAM - - - - Some stack templates might include resources that can affect permissions in your AWS - account; for example, by creating new AWS Identity and Access Management (IAM) users. - For those stacks, you must explicitly acknowledge this by specifying one of these - capabilities. - - - - The following IAM resources require you to specify either the CAPABILITY_IAM - or CAPABILITY_NAMED_IAM capability. - -
    • - - If you have IAM resources, you can specify either capability. - -
    • - - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. - - -
    • - - If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities - error. - -
    - - If your stack template contains these resources, we recommend that you review all - permissions associated with them and edit their permissions if necessary. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - -
  • - - CAPABILITY_AUTO_EXPAND - - - - Some template contain macros. Macros perform custom processing on templates; this - can include simple actions like find-and-replace operations, all the way to extensive - transformations of entire templates. Because of this, users typically create a change - set from the processed template, so that they can review the changes resulting from - the macros before actually creating the stack. If your stack template contains one - or more macros, and you choose to create a stack directly from the processed template, - without first reviewing the resulting changes in a change set, you must acknowledge - this capability. This includes the AWS::Include - and AWS::Serverless - transforms, which are macros hosted by AWS CloudFormation. - - - - If you want to create a stack from a stack template that contains macros and - nested stacks, you must create the stack directly from the template using this capability. - - - - You should only create stacks directly from a stack template that contains macros - if you know what processing the macro performs. - - - - Each macro relies on an underlying Lambda service function for processing stack templates. - Be aware that the Lambda function owner can update the function operation without - AWS CloudFormation being notified. - - - - For more information, see Using - AWS CloudFormation Macros to Perform Custom Processing on Templates. - -
- - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this CreateStack request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to create a stack with the same name. You might retry CreateStack requests - to ensure that AWS CloudFormation successfully received them. - - - - All events triggered by a given stack operation are assigned the same client request - token, which you can use to track operations. For example, if you execute a CreateStack - operation with the token token1, then all the StackEvents - generated by that operation will have ClientRequestToken set as token1. - - - - In the console, stack operations display the client request token on the Events tab. - Stack operations that are initiated from the console use the token format Console-StackOperation-ID, - which helps you easily identify the stack operation . For example, if you create a - stack using the console, each stack event would be assigned the same token in the - following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. - - - - - - - Gets and sets the property DisableRollback. - - Set to true to disable rollback of the stack if stack creation failed. - You can specify either DisableRollback or OnFailure, but - not both. - - - - Default: false - - - - - - Gets and sets the property EnableTerminationProtection. - - Whether to enable termination protection on the specified stack. If a user attempts - to delete a stack with termination protection enabled, the operation fails and the - stack remains unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination - protection is disabled on stacks by default. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - - - - Gets and sets the property NotificationARNs. - - The Simple Notification Service (SNS) topic ARNs to publish stack related events. - You can find your SNS topic ARNs using the SNS console or your Command Line Interface - (CLI). - - - - - - Gets and sets the property OnFailure. - - Determines what action will be taken if stack creation fails. This must be one of: - DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or - DisableRollback, but not both. - - - - Default: ROLLBACK - - - - - - Gets and sets the property Parameters. - - A list of Parameter structures that specify input parameters for the - stack. For more information, see the Parameter - data type. - - - - - - Gets and sets the property ResourceTypes. - - The template resource types that you have permissions to work with for this create - stack action, such as AWS::EC2::Instance, AWS::EC2::*, or - Custom::MyCustomInstance. Use the following syntax to describe template - resource types: AWS::* (for all AWS resource), Custom::* - (for all custom resources), Custom::logical_ID (for a specific - custom resource), AWS::service_name::* (for all resources of a - particular AWS service), and AWS::service_name::resource_logical_ID - (for a specific AWS resource). - - - - If the list of resource types doesn't include a resource that you're creating, the - stack creation fails. By default, AWS CloudFormation grants permissions to all resource - types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific - condition keys in IAM policies. For more information, see Controlling - Access with AWS Identity and Access Management. - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's - credentials to make calls on your behalf. AWS CloudFormation always uses this role - for all future operations on the stack. As long as users have permission to operate - on the stack, AWS CloudFormation uses this role even if the users don't have permission - to pass it. Ensure that the role grants least privilege. - - - - If you don't specify a value, AWS CloudFormation uses the role that was previously - associated with the stack. If no role is available, AWS CloudFormation uses a temporary - session that is generated from your user credentials. - - - - - - Gets and sets the property RollbackConfiguration. - - The rollback triggers for AWS CloudFormation to monitor during stack creation and - updating operations, and for the specified monitoring period afterwards. - - - - - - Gets and sets the property StackName. - - The name that is associated with the stack. The name must be unique in the Region - in which you are creating the stack. - - - - A stack name can contain only alphanumeric characters (case sensitive) and hyphens. - It must start with an alphabetic character and cannot be longer than 128 characters. - - - - - - - Gets and sets the property StackPolicyBody. - - Structure containing the stack policy body. For more information, go to - Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. - You can specify either the StackPolicyBody or the StackPolicyURL - parameter, but not both. - - - - - - Gets and sets the property StackPolicyURL. - - Location of a file containing the stack policy. The URL must point to a policy (maximum - size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify - either the StackPolicyBody or the StackPolicyURL parameter, - but not both. - - - - - - Gets and sets the property Tags. - - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these - tags to the resources created in the stack. A maximum number of 50 tags can be specified. - - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body with a minimum length of 1 byte and a maximum - length of 51,200 bytes. For more information, go to Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify either the TemplateBody or the TemplateURL - parameter, but not both. - - - - - - Gets and sets the property TemplateURL. - - Location of file containing the template body. The URL must point to a template (max - size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. - For more information, go to the Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify either the TemplateBody or the TemplateURL - parameter, but not both. - - - - - - Gets and sets the property TimeoutInMinutes. - - The amount of time that can pass before the stack status becomes CREATE_FAILED; if - DisableRollback is not set or is set to false, the stack - will be rolled back. - - - - - - The output for a CreateStack action. - - - - - Gets and sets the property StackId. - - Unique identifier of the stack. - - - - - - Container for the parameters to the CreateStackSet operation. - Creates a stack set. - - - - - Gets and sets the property AdministrationRoleARN. - - The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. - - - - - Specify an IAM role only if you are using customized administrator roles to control - which users or groups can manage specific stack sets within the same administrator - account. For more information, see Prerequisites: - Granting Permissions for Stack Set Operations in the AWS CloudFormation User - Guide. - - - - - - Gets and sets the property AutoDeployment. - - Describes whether StackSets automatically deploys to AWS Organizations accounts that - are added to the target organization or organizational unit (OU). Specify only if - PermissionModel is SERVICE_MANAGED. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - To create a stack set with service-managed permissions while signed in to the management - account, specify SELF. - -
  • - - To create a stack set with service-managed permissions while signed in to a delegated - administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated admin in the management account. - For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - Stack sets with service-managed permissions are created in the management account, - including stack sets that are created by delegated administrators. - - - - - - Gets and sets the property Capabilities. - - In some cases, you must explicitly acknowledge that your stack set template contains - certain capabilities in order for AWS CloudFormation to create the stack set and related - stack instances. - -
  • - - CAPABILITY_IAM and CAPABILITY_NAMED_IAM - - - - Some stack templates might include resources that can affect permissions in your AWS - account; for example, by creating new AWS Identity and Access Management (IAM) users. - For those stack sets, you must explicitly acknowledge this by specifying one of these - capabilities. - - - - The following IAM resources require you to specify either the CAPABILITY_IAM - or CAPABILITY_NAMED_IAM capability. - -
    • - - If you have IAM resources, you can specify either capability. - -
    • - - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. - - -
    • - - If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities - error. - -
    - - If your stack template contains these resources, we recommend that you review all - permissions associated with them and edit their permissions if necessary. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - -
  • - - CAPABILITY_AUTO_EXPAND - - - - Some templates reference macros. If your stack set template references one or more - macros, you must create the stack set directly from the processed template, without - first reviewing the resulting changes in a change set. To create the stack set directly, - you must acknowledge this capability. For more information, see Using - AWS CloudFormation Macros to Perform Custom Processing on Templates. - - - - Stack sets with service-managed permissions do not currently support the use of macros - in templates. (This includes the AWS::Include - and AWS::Serverless - transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this - capability for a stack set with service-managed permissions, if you reference a macro - in your template the stack set operation will fail. - -
- - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this CreateStackSet request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to create another stack set with the same name. You might retry CreateStackSet - requests to ensure that AWS CloudFormation successfully received them. - - - - If you don't specify an operation ID, the SDK generates one automatically. - - - - - - Gets and sets the property Description. - - A description of the stack set. You can use the description to identify the stack - set's purpose or other important information. - - - - - - Gets and sets the property ExecutionRoleName. - - The name of the IAM execution role to use to create the stack set. If you do not specify - an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole - role for the stack set operation. - - - - Specify an IAM role only if you are using customized execution roles to control which - stack resources users and groups can include in their stack sets. - - - - - - Gets and sets the property Parameters. - - The input parameters for the stack set template. - - - - - - Gets and sets the property PermissionModel. - - Describes how the IAM roles required for stack set operations are created. By default, - SELF-MANAGED is specified. - - - - - - - Gets and sets the property StackSetName. - - The name to associate with the stack set. The name must be unique in the Region where - you create your stack set. - - - - A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. - It must start with an alphabetic character and can't be longer than 128 characters. - - - - - - - Gets and sets the property Tags. - - The key-value pairs to associate with this stack set and the stacks created from it. - AWS CloudFormation also propagates these tags to supported resources that are created - in the stacks. A maximum number of 50 tags can be specified. - - - - If you specify tags as part of a CreateStackSet action, AWS CloudFormation - checks to see if you have the required IAM permission to tag resources. If you don't, - the entire CreateStackSet action fails with an access denied - error, and the stack set is not created. - - - - - - Gets and sets the property TemplateBody. - - The structure that contains the template body, with a minimum length of 1 byte and - a maximum length of 51,200 bytes. For more information, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify either the TemplateBody or the TemplateURL parameter, - but not both. - - - - - - Gets and sets the property TemplateURL. - - The location of the file that contains the template body. The URL must point to a - template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a - Systems Manager document. For more information, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify either the TemplateBody or the TemplateURL parameter, - but not both. - - - - - - This is the response object from the CreateStackSet operation. - - - - - Gets and sets the property StackSetId. - - The ID of the stack set that you're creating. - - - - - - Container for the parameters to the DeactivateType operation. - Deactivates a public extension that was previously activated in this account and region. - - - - Once deactivated, an extension cannot be used in any CloudFormation operation. This - includes stack update operations where the stack template includes the extension, - even if no updates are being made to the extension. In addition, deactivated extensions - are not automatically updated if a new version of the extension is released. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) for the extension, in this account and region. - - - - Conditional: You must specify either Arn, or TypeName and - Type. - - - - - - Gets and sets the property Type. - - The extension type. - - - - Conditional: You must specify either Arn, or TypeName and - Type. - - - - - - Gets and sets the property TypeName. - - The type name of the extension, in this account and region. If you specified a type - name alias when enabling the extension, use the type name alias. - - - - Conditional: You must specify either Arn, or TypeName and - Type. - - - - - - This is the response object from the DeactivateType operation. - - - - - Container for the parameters to the DeleteChangeSet operation. - Deletes the specified change set. Deleting change sets ensures that no one executes - the wrong change set. - - - - If the call successfully completes, AWS CloudFormation successfully deleted the change - set. - - - - If IncludeNestedStacks specifies True during the creation - of the nested change set, then DeleteChangeSet will delete all change - sets that belong to the stacks hierarchy and will also delete all change sets for - nested stacks with the status of REVIEW_IN_PROGRESS. - - - - - - Gets and sets the property ChangeSetName. - - The name or Amazon Resource Name (ARN) of the change set that you want to delete. - - - - - - Gets and sets the property StackName. - - If you specified the name of a change set to delete, specify the stack name or ID - (ARN) that is associated with it. - - - - - - The output for the DeleteChangeSet action. - - - - - Container for the parameters to the DeleteStackInstances operation. - Deletes stack instances for the specified accounts, in the specified Regions. - - - - - Gets and sets the property Accounts. - - [Self-managed permissions] The names of the AWS accounts that you want to delete stack - instances for. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property DeploymentTargets. - - [Service-managed permissions] The AWS Organizations accounts from which to delete - stack instances. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - If you don't specify an operation ID, the SDK generates one automatically. - - - - The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation - performs the stack set operation only once, even if you retry the request multiple - times. You can retry stack set operation requests to ensure that AWS CloudFormation - successfully received them. - - - - Repeating this stack set operation with a new operation ID retries all stack instances - whose status is OUTDATED. - - - - - - Gets and sets the property OperationPreferences. - - Preferences for how AWS CloudFormation performs this stack set operation. - - - - - - Gets and sets the property Regions. - - The Regions where you want to delete stack set instances. - - - - - - Gets and sets the property RetainStacks. - - Removes the stack instances from the specified stack set, but doesn't delete the stacks. - You can't reassociate a retained stack or add an existing, saved stack to a new stack - set. - - - - For more information, see Stack - set operation options. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to delete stack instances for. - - - - - - This is the response object from the DeleteStackInstances operation. - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - - - Container for the parameters to the DeleteStack operation. - Deletes a specified stack. Once the call completes successfully, stack deletion starts. - Deleted stacks do not show up in the DescribeStacks API if the deletion has - been completed successfully. - - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this DeleteStack request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to delete a stack with the same name. You might retry DeleteStack requests - to ensure that AWS CloudFormation successfully received them. - - - - All events triggered by a given stack operation are assigned the same client request - token, which you can use to track operations. For example, if you execute a CreateStack - operation with the token token1, then all the StackEvents - generated by that operation will have ClientRequestToken set as token1. - - - - In the console, stack operations display the client request token on the Events tab. - Stack operations that are initiated from the console use the token format Console-StackOperation-ID, - which helps you easily identify the stack operation . For example, if you create a - stack using the console, each stack event would be assigned the same token in the - following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. - - - - - - - Gets and sets the property RetainResources. - - For stacks in the DELETE_FAILED state, a list of resource logical IDs - that are associated with the resources you want to retain. During deletion, AWS CloudFormation - deletes the stack but does not delete the retained resources. - - - - Retaining resources is useful when you cannot delete a resource, such as a non-empty - S3 bucket, but you want to delete the stack. - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's - credentials to make calls on your behalf. - - - - If you don't specify a value, AWS CloudFormation uses the role that was previously - associated with the stack. If no role is available, AWS CloudFormation uses a temporary - session that is generated from your user credentials. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack. - - - - - - This is the response object from the DeleteStack operation. - - - - - Container for the parameters to the DeleteStackSet operation. - Deletes a stack set. Before you can delete a stack set, all of its member stack instances - must be deleted. For more information about how to do this, see DeleteStackInstances. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you're deleting. You can obtain this value - by running ListStackSets. - - - - - - This is the response object from the DeleteStackSet operation. - - - - - [Service-managed permissions] The AWS Organizations accounts to which StackSets deploys. - StackSets does not deploy stack instances to the organization management account, - even if the organization management account is in your organization or in an OU in - your organization. - - - - For update operations, you can specify either Accounts or OrganizationalUnitIds. - For create and delete operations, specify OrganizationalUnitIds. - - - - - - Gets and sets the property Accounts. - - The names of one or more AWS accounts for which you want to deploy stack set updates. - - - - - - Gets and sets the property AccountsUrl. - - Returns the value of the AccountsUrl property. - - - - - - Gets and sets the property OrganizationalUnitIds. - - The organization root ID or organizational unit (OU) IDs to which StackSets deploys. - - - - - - Container for the parameters to the DeregisterType operation. - Marks an extension or extension version as DEPRECATED in the CloudFormation - registry, removing it from active use. Deprecated extensions or extension versions - cannot be used in CloudFormation operations. - - - - To deregister an entire extension, you must individually deregister all active versions - of that extension. If an extension has only a single active version, deregistering - that version results in the extension itself being deregistered and marked as deprecated - in the registry. - - - - You cannot deregister the default version of an extension if there are other active - version of that extension. If you do deregister the default version of an extension, - the textensionype itself is deregistered as well and marked as deprecated. - - - - To view the deprecation status of an extension or extension version, use DescribeType. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property VersionId. - - The ID of a specific version of the extension. The version ID is the value at the - end of the Amazon Resource Name (ARN) assigned to the extension version when it is - registered. - - - - - - This is the response object from the DeregisterType operation. - - - - - Container for the parameters to the DescribeAccountLimits operation. - Retrieves your account's AWS CloudFormation limits, such as the maximum number of - stacks that you can create in your account. For more information about account limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of limits that you want to retrieve. - - - - - - The output for the DescribeAccountLimits action. - - - - - Gets and sets the property AccountLimits. - - An account limit structure that contain a list of AWS CloudFormation account limits - and their values. - - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB in size, a string that identifies the next page of limits. - If no additional page exists, this value is null. - - - - - - Container for the parameters to the DescribeChangeSet operation. - Returns the inputs for the change set and a list of changes that AWS CloudFormation - will make if you execute the change set. For more information, see Updating - Stacks Using Change Sets in the AWS CloudFormation User Guide. - - - - - Gets and sets the property ChangeSetName. - - The name or Amazon Resource Name (ARN) of the change set that you want to describe. - - - - - - Gets and sets the property NextToken. - - A string (provided by the DescribeChangeSet response output) that identifies - the next page of information that you want to retrieve. - - - - - - Gets and sets the property StackName. - - If you specified the name of a change set, specify the stack name or ID (ARN) of the - change set you want to describe. - - - - - - The output for the DescribeChangeSet action. - - - - - Gets and sets the property Capabilities. - - If you execute the change set, the list of capabilities that were explicitly acknowledged - when the change set was created. - - - - - - Gets and sets the property Changes. - - A list of Change structures that describes the resources AWS CloudFormation - changes if you execute the change set. - - - - - - Gets and sets the property ChangeSetId. - - The ARN of the change set. - - - - - - Gets and sets the property ChangeSetName. - - The name of the change set. - - - - - - Gets and sets the property CreationTime. - - The start time when the change set was created, in UTC. - - - - - - Gets and sets the property Description. - - Information about the change set. - - - - - - Gets and sets the property ExecutionStatus. - - If the change set execution status is AVAILABLE, you can execute the - change set. If you can’t execute the change set, the status indicates why. For example, - a change set might be in an UNAVAILABLE state because AWS CloudFormation - is still creating it or in an OBSOLETE state because the stack was already - updated. - - - - - - Gets and sets the property IncludeNestedStacks. - - Verifies if IncludeNestedStacks is set to True. - - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB, a string that identifies the next page of changes. If - there is no additional page, this value is null. - - - - - - Gets and sets the property NotificationARNs. - - The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be - associated with the stack if you execute the change set. - - - - - - Gets and sets the property Parameters. - - A list of Parameter structures that describes the input parameters and - their values used to create the change set. For more information, see the Parameter - data type. - - - - - - Gets and sets the property ParentChangeSetId. - - Specifies the change set ID of the parent change set in the current nested change - set hierarchy. - - - - - - Gets and sets the property RollbackConfiguration. - - The rollback triggers for AWS CloudFormation to monitor during stack creation and - updating operations, and for the specified monitoring period afterwards. - - - - - - Gets and sets the property RootChangeSetId. - - Specifies the change set ID of the root change set in the current nested change set - hierarchy. - - - - - - Gets and sets the property StackId. - - The ARN of the stack that is associated with the change set. - - - - - - Gets and sets the property StackName. - - The name of the stack that is associated with the change set. - - - - - - Gets and sets the property Status. - - The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, - or FAILED. - - - - - - Gets and sets the property StatusReason. - - A description of the change set's status. For example, if your attempt to create a - change set failed, AWS CloudFormation shows the error message. - - - - - - Gets and sets the property Tags. - - If you execute the change set, the tags that will be associated with the stack. - - - - - - Container for the parameters to the DescribePublisher operation. - Returns information about a CloudFormation extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - For more information on registering as a publisher, see: - - - - - - - Gets and sets the property PublisherId. - - The ID of the extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - - - This is the response object from the DescribePublisher operation. - - - - - Gets and sets the property IdentityProvider. - - The type of account used as the identity provider when registering this publisher - with CloudFormation. - - - - - - Gets and sets the property PublisherId. - - The ID of the extension publisher. - - - - - - Gets and sets the property PublisherProfile. - - The URL to the publisher's profile with the identity provider. - - - - - - Gets and sets the property PublisherStatus. - - Whether the publisher is verified. Currently, all registered publishers are verified. - - - - - - Container for the parameters to the DescribeStackDriftDetectionStatus operation. - Returns information about a stack drift detection operation. A stack drift detection - operation detects whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. A stack is considered to have drifted if one or - more of its resources have drifted. For more information on stack and resource drift, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift - returns a StackDriftDetectionId you can use to monitor the progress of - the operation using DescribeStackDriftDetectionStatus. Once the drift - detection operation has completed, use DescribeStackResourceDrifts to return - drift information about the stack and its resources. - - - - - - Gets and sets the property StackDriftDetectionId. - - The ID of the drift detection results of this operation. - - - - AWS CloudFormation generates new results, with a new drift detection ID, each time - this operation is run. However, the number of drift results AWS CloudFormation retains - for any given stack, and for how long, may vary. - - - - - - This is the response object from the DescribeStackDriftDetectionStatus operation. - - - - - Gets and sets the property DetectionStatus. - - The status of the stack drift detection operation. - -
  • - - DETECTION_COMPLETE: The stack drift detection operation has successfully - completed for all resources in the stack that support drift detection. (Resources - that do not currently support stack detection remain unchecked.) - - - - If you specified logical resource IDs for AWS CloudFormation to use as a filter for - the stack drift detection operation, only the resources with those logical IDs are - checked for drift. - -
  • - - DETECTION_FAILED: The stack drift detection operation has failed for - at least one resource in the stack. Results will be available for resources on which - AWS CloudFormation successfully completed drift detection. - -
  • - - DETECTION_IN_PROGRESS: The stack drift detection operation is currently - in progress. - -
- - - - - Gets and sets the property DetectionStatusReason. - - The reason the stack drift detection operation has its current status. - - - - - - Gets and sets the property DriftedStackResourceCount. - - Total number of stack resources that have drifted. This is NULL until the drift detection - operation reaches a status of DETECTION_COMPLETE. This value will be - 0 for stacks whose drift status is IN_SYNC. - - - - - - Gets and sets the property StackDriftDetectionId. - - The ID of the drift detection results of this operation. - - - - AWS CloudFormation generates new results, with a new drift detection ID, each time - this operation is run. However, the number of reports AWS CloudFormation retains for - any given stack, and for how long, may vary. - - - - - - Gets and sets the property StackDriftStatus. - - Status of the stack's actual configuration compared to its expected configuration. - - -
  • - - DRIFTED: The stack differs from its expected template configuration. - A stack is considered to have drifted if one or more of its resources have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the stack differs - from its expected template configuration. - -
  • - - IN_SYNC: The stack's actual configuration matches its expected template - configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - Gets and sets the property StackId. - - The ID of the stack. - - - - - - Gets and sets the property Timestamp. - - Time at which the stack drift detection operation was initiated. - - - - - - Container for the parameters to the DescribeStackEvents operation. - Returns all stack related events for a specified stack in reverse chronological order. - For more information about a stack's event history, go to Stacks - in the AWS CloudFormation User Guide. - - - - You can list events for stacks that have failed to create or have been deleted by - specifying the unique stack identifier (stack ID). - - - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of events that you want to retrieve. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - - - The output for a DescribeStackEvents action. - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB in size, a string that identifies the next page of events. - If no additional page exists, this value is null. - - - - - - Gets and sets the property StackEvents. - - A list of StackEvents structures. - - - - - - Container for the parameters to the DescribeStackInstance operation. - Returns the stack instance that's associated with the specified stack set, AWS account, - and Region. - - - - For a list of stack instances that are associated with a specific stack set, use ListStackInstances. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property StackInstanceAccount. - - The ID of an AWS account that's associated with this stack instance. - - - - - - Gets and sets the property StackInstanceRegion. - - The name of a Region that's associated with this stack instance. - - - - - - Gets and sets the property StackSetName. - - The name or the unique stack ID of the stack set that you want to get stack instance - information for. - - - - - - This is the response object from the DescribeStackInstance operation. - - - - - Gets and sets the property StackInstance. - - The stack instance that matches the specified request parameters. - - - - - - Container for the parameters to the DescribeStackResourceDrifts operation. - Returns drift information for the resources that have been checked for drift in the - specified stack. This includes actual and expected configuration values for resources - where AWS CloudFormation detects configuration drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all supported resources for a given stack. - - - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of stack resource drift results. - - - - - - Gets and sets the property StackName. - - The name of the stack for which you want drift information. - - - - - - Gets and sets the property StackResourceDriftStatusFilters. - - The resource drift status values to use as filters for the resource drift results - returned. - -
  • - - DELETED: The resource differs from its expected template configuration - in that the resource has been deleted. - -
  • - - MODIFIED: One or more resource properties differ from their expected - template values. - -
  • - - IN_SYNC: The resources's actual configuration matches its expected template - configuration. - -
  • - - NOT_CHECKED: AWS CloudFormation does not currently return this value. - -
- - - - - This is the response object from the DescribeStackResourceDrifts operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts - again and assign that token to the request object's NextToken parameter. - If the request returns all results, NextToken is set to null. - - - - - - Gets and sets the property StackResourceDrifts. - - Drift information for the resources that have been checked for drift in the specified - stack. This includes actual and expected configuration values for resources where - AWS CloudFormation detects drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - - - Container for the parameters to the DescribeStackResource operation. - Returns a description of the specified resource in the specified stack. - - - - For deleted stacks, DescribeStackResource returns resource information for up to 90 - days after the stack has been deleted. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource as specified in the template. - - - - Default: There is no default value. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - - - The output for a DescribeStackResource action. - - - - - Gets and sets the property StackResourceDetail. - - A StackResourceDetail structure containing the description of the specified - resource in the specified stack. - - - - - - Container for the parameters to the DescribeStackResources operation. - Returns AWS resource descriptions for running and deleted stacks. If StackName - is specified, all the associated resources that are part of the stack are returned. - If PhysicalResourceId is specified, the associated resources of the stack - that the resource belongs to are returned. - - - - Only the first 100 resources will be returned. If your stack has more resources than - this, you should use ListStackResources instead. - - - - For deleted stacks, DescribeStackResources returns resource information - for up to 90 days after the stack has been deleted. - - - - You must specify either StackName or PhysicalResourceId, - but not both. In addition, you can specify LogicalResourceId to filter - the returned result. For more information about resources, the LogicalResourceId - and PhysicalResourceId, go to the AWS - CloudFormation User Guide. - - - - A ValidationError is returned if you specify both StackName - and PhysicalResourceId in the same request. - - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource as specified in the template. - - - - Default: There is no default value. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier that corresponds to a physical instance ID of a resource - supported by AWS CloudFormation. - - - - For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId - corresponds to the InstanceId. You can pass the EC2 InstanceId - to DescribeStackResources to find which stack the instance belongs to - and what other resources are part of the stack. - - - - Required: Conditional. If you do not specify PhysicalResourceId, you - must specify StackName. - - - - Default: There is no default value. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - Required: Conditional. If you do not specify StackName, you must specify - PhysicalResourceId. - - - - - - The output for a DescribeStackResources action. - - - - - Gets and sets the property StackResources. - - A list of StackResource structures. - - - - - - Container for the parameters to the DescribeStackSetOperation operation. - Returns the description of the specified stack set operation. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property OperationId. - - The unique ID of the stack set operation. - - - - - - Gets and sets the property StackSetName. - - The name or the unique stack ID of the stack set for the stack operation. - - - - - - This is the response object from the DescribeStackSetOperation operation. - - - - - Gets and sets the property StackSetOperation. - - The specified stack set operation. - - - - - - Container for the parameters to the DescribeStackSet operation. - Returns the description of the specified stack set. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set whose description you want. - - - - - - This is the response object from the DescribeStackSet operation. - - - - - Gets and sets the property StackSet. - - The specified stack set. - - - - - - Container for the parameters to the DescribeStacks operation. - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of stacks that you want to retrieve. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - - - The output for a DescribeStacks action. - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB in size, a string that identifies the next page of stacks. - If no additional page exists, this value is null. - - - - - - Gets and sets the property Stacks. - - A list of stack structures. - - - - - - Container for the parameters to the DescribeTypeRegistration operation. - Returns information about an extension's registration, including its current status - and type and version identifiers. - - - - When you initiate a registration request using RegisterType , - you can then use DescribeTypeRegistration to monitor the progress - of that registration request. - - - - Once the registration request has completed, use DescribeType - to return detailed information about an extension. - - - - - - Gets and sets the property RegistrationToken. - - The identifier for this registration request. - - - - This registration token is generated by CloudFormation when you initiate a registration - request using RegisterType . - - - - - - This is the response object from the DescribeTypeRegistration operation. - - - - - Gets and sets the property Description. - - The description of the extension registration request. - - - - - - Gets and sets the property ProgressStatus. - - The current status of the extension registration request. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) of the extension being registered. - - - - For registration requests with a ProgressStatus of other than COMPLETE, - this will be null. - - - - - - Gets and sets the property TypeVersionArn. - - The Amazon Resource Name (ARN) of this specific version of the extension being registered. - - - - For registration requests with a ProgressStatus of other than COMPLETE, - this will be null. - - - - - - Container for the parameters to the DescribeType operation. - Returns detailed information about an extension that has been registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property PublicVersionNumber. - - The version number of a public third-party extension. - - - - - - Gets and sets the property PublisherId. - - The publisher ID of the extension publisher. - - - - Extensions provided by Amazon are not assigned a publisher ID. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property VersionId. - - The ID of a specific version of the extension. The version ID is the value at the - end of the Amazon Resource Name (ARN) assigned to the extension version when it is - registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - - - - This is the response object from the DescribeType operation. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension. - - - - - - Gets and sets the property AutoUpdate. - - Whether CloudFormation automatically updates the extension in this account and region - when a new minor version is published by the extension publisher. Major versions - released by the publisher must be manually updated. For more information, see Activating - public extensions for use in your account in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property ConfigurationSchema. - - A JSON string that represent the current configuration data for the extension in this - account and region. - - - - To set the configuration data for an extension, use SetTypeConfiguration. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - - - Gets and sets the property DefaultVersionId. - - The ID of the default version of the extension. The default version is used when the - extension version is not specified. - - - - This applies only to private extensions you have registered in your account. For public - extensions, both those provided by Amazon and published by third parties, CloudFormation - returns null. For more information, see RegisterType. - - - - To set the default version of an extension, use SetTypeDefaultVersion - . - - - - - - Gets and sets the property DeprecatedStatus. - - The deprecation status of the extension version. - - - - Valid values include: - -
  • - - LIVE: The extension is activated or registered and can be used in CloudFormation - operations, dependent on its provisioning behavior and visibility scope. - -
  • - - DEPRECATED: The extension has been deactivated or deregistered and can - no longer be used in CloudFormation operations. - -
- - For public third-party extensions, CloudFormation returns null. - - - - - - Gets and sets the property Description. - - The description of the extension. - - - - - - Gets and sets the property DocumentationUrl. - - The URL of a page providing detailed documentation for this extension. - - - - - - Gets and sets the property ExecutionRoleArn. - - The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. - This applies only to private extensions you have registered in your account. For more - information, see RegisterType. - - - - If the registered extension calls any AWS APIs, you must create an IAM - execution role that includes the necessary permissions to call those AWS - APIs, and provision that execution role in your account. CloudFormation then assumes - that execution role to provide your extension with the appropriate credentials. - - - - - - Gets and sets the property IsActivated. - - Whether or not the extension is activated in the account and region. - - - - This only applies to public third-party extensions. For all other extensions, CloudFormation - returns null. - - - - - - Gets and sets the property IsDefaultVersion. - - Whether the specified extension version is set as the default version. - - - - This applies only to private extensions you have registered in your account, and extensions - published by Amazon. For public third-party extensions, whether or not they are activated - in your account, CloudFormation returns null. - - - - - - Gets and sets the property LastUpdated. - - When the specified extension version was registered. This applies only to: - -
  • - - Private extensions you have registered in your account. For more information, see - RegisterType. - -
  • - - Public extensions you have activated in your account with auto-update specified. For - more information, see ActivateType. - -
- - - - - Gets and sets the property LatestPublicVersion. - - The latest version of a public extension that is available for use. - - - - This only applies if you specify a public extension, and you do not specify a version. - For all other requests, CloudFormation returns null. - - - - - - Gets and sets the property LoggingConfig. - - Contains logging configuration information for private extensions. This applies only - to private extensions you have registered in your account. For public extensions, - both those provided by Amazon and published by third parties, CloudFormation returns - null. For more information, see RegisterType. - - - - - - Gets and sets the property OriginalTypeArn. - - For public extensions that have been activated for this account and region, the Amazon - Resource Name (ARN) of the public extension. - - - - - - Gets and sets the property OriginalTypeName. - - For public extensions that have been activated for this account and region, the type - name of the public extension. - - - - If you specified a TypeNameAlias when enabling the extension in this - account and region, CloudFormation treats that alias as the extension's type name - within the account and region, not the type name of the public extension. For more - information, see Specifying - aliases to refer to extensions in the CloudFormation User Guide. - - - - - - Gets and sets the property ProvisioningType. - - For resource type extensions, the provisioning behavior of the resource type. AWS - CloudFormation determines the provisioning type during registration, based on the - types of handlers in the schema handler package submitted. - - - - Valid values include: - -
  • - - FULLY_MUTABLE: The resource type includes an update handler to process - updates to the type during stack update operations. - -
  • - - IMMUTABLE: The resource type does not include an update handler, so - the type cannot be updated and must instead be replaced during stack update operations. - -
  • - - NON_PROVISIONABLE: The resource type does not include all of the following - handlers, and therefore cannot actually be provisioned. - -
    • - - create - -
    • - - read - -
    • - - delete - -
- - - - - Gets and sets the property PublicVersionNumber. - - The version number of a public third-party extension. - - - - This applies only if you specify a public extension you have activated in your account, - or specify a public extension without specifying a version. For all other extensions, - CloudFormation returns null. - - - - - - Gets and sets the property PublisherId. - - The publisher ID of the extension publisher. - - - - This applies only to public third-party extensions. For private registered extensions, - and extensions provided by Amazon, CloudFormation returns null. - - - - - - Gets and sets the property RequiredActivatedTypes. - - For extensions that are modules, the public third-party extensions that must be activated - in your account in order for the module itself to be activated. - - - - - - Gets and sets the property Schema. - - The schema that defines the extension. - - - - For more information on extension schemas, see Resource - Provider Schema in the CloudFormation CLI User Guide. - - - - - - Gets and sets the property SourceUrl. - - The URL of the source code for the extension. - - - - - - Gets and sets the property TimeCreated. - - When the specified private extension version was registered or activated in your account. - - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - If the extension is a public third-party type you have activated with a type name - alias, CloudFormation returns the type name alias. For more information, see ActivateType. - - - - - - Gets and sets the property TypeTestsStatus. - - The contract test status of the registered extension version. To return the extension - test status of a specifc extension version, you must specify VersionId. - - - - - This applies only to registered private extension versions. CloudFormation does not - return this information for public extensions, whether or not they are activated in - your account. - -
  • - - PASSED: The extension has passed all its contract tests. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation Command - Line Interface User Guide. - -
  • - - FAILED: The extension has failed one or more contract tests. - -
  • - - IN_PROGRESS: Contract tests are currently being performed on the extension. - -
  • - - NOT_TESTED: Contract tests have not been performed on the extension. - -
- - - - - Gets and sets the property TypeTestsStatusDescription. - - The description of the test status. To return the extension test status of a specifc - extension version, you must specify VersionId. - - - - This applies only to registered private extension versions. CloudFormation does not - return this information for public extensions, whether or not they are activated in - your account. - - - - - - Gets and sets the property Visibility. - - The scope at which the extension is visible and usable in CloudFormation operations. - - - - Valid values include: - -
  • - - PRIVATE: The extension is only visible and usable within the account - in which it is registered. AWS CloudFormation marks any extensions you register as - PRIVATE. - -
  • - - PUBLIC: The extension is publically visible and usable within any Amazon - account. - -
- - - - - Container for the parameters to the DetectStackDrift operation. - Detects whether a stack's actual configuration differs, or has drifted, from - it's expected configuration, as defined in the stack template and any values specified - as template parameters. For each resource in the stack that supports drift detection, - AWS CloudFormation compares the actual configuration of the resource with its expected - template configuration. Only resource properties explicitly defined in the stack template - are checked for drift. A stack is considered to have drifted if one or more of its - resources differ from their expected template configurations. For more information, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to detect drift on all supported resources for a - given stack, or DetectStackResourceDrift to detect drift on individual resources. - - - - For a list of stack resources that currently support drift detection, see Resources - that Support Drift Detection. - - - - DetectStackDrift can take up to several minutes, depending on the number - of resources contained within the stack. Use DescribeStackDriftDetectionStatus - to monitor the progress of a detect stack drift operation. Once the drift detection - operation has completed, use DescribeStackResourceDrifts to return drift information - about the stack and its resources. - - - - When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested - stacks belonging to that stack. Perform DetectStackDrift directly on - the nested stack itself. - - - - - - Gets and sets the property LogicalResourceIds. - - The logical names of any resources you want to use as filters. - - - - - - Gets and sets the property StackName. - - The name of the stack for which you want to detect drift. - - - - - - This is the response object from the DetectStackDrift operation. - - - - - Gets and sets the property StackDriftDetectionId. - - The ID of the drift detection results of this operation. - - - - AWS CloudFormation generates new results, with a new drift detection ID, each time - this operation is run. However, the number of drift results AWS CloudFormation retains - for any given stack, and for how long, may vary. - - - - - - Container for the parameters to the DetectStackResourceDrift operation. - Returns information about whether a resource's actual configuration differs, or has - drifted, from it's expected configuration, as defined in the stack template - and any values specified as template parameters. This information includes actual - and expected property values for resources in which AWS CloudFormation detects drift. - Only resource properties explicitly defined in the stack template are checked for - drift. For more information about stack and resource drift, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackResourceDrift to detect drift on individual resources, - or DetectStackDrift to detect drift on all resources in a given stack that - support drift detection. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource for which to return drift information. - - - - - - Gets and sets the property StackName. - - The name of the stack to which the resource belongs. - - - - - - This is the response object from the DetectStackResourceDrift operation. - - - - - Gets and sets the property StackResourceDrift. - - Information about whether the resource's actual configuration has drifted from its - expected template configuration, including actual and expected property values and - any differences detected. - - - - - - Container for the parameters to the DetectStackSetDrift operation. - Detect drift on a stack set. When CloudFormation performs drift detection on a stack - set, it performs drift detection on the stack associated with each stack instance - in the stack set. For more information, see How - CloudFormation Performs Drift Detection on a Stack Set. - - - - DetectStackSetDrift returns the OperationId of the stack - set drift detection operation. Use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. The drift detection - operation may take some time, depending on the number of stack instances included - in the stack set, as well as the number of resources included in each stack. - - - - Once the operation has completed, use the following actions to return drift information: - -
  • - - Use DescribeStackSet to return detailed information about the - stack set, including detailed information about the last completed drift operation - performed on the stack set. (Information about drift operations that are in progress - is not included.) - -
  • - - Use ListStackInstances to return a list of stack instances belonging - to the stack set, including the drift status and last drift time checked of each instance. - -
  • - - Use DescribeStackInstance to return detailed information about - a specific stack instance, including its drift status and last drift time checked. - -
- - For more information on performing a drift detection operation on a stack set, see - Detecting - Unmanaged Changes in Stack Sets. - - - - You can only run a single drift detection operation on a given stack set at one time. - - - - - To stop a drift detection stack set operation, use StopStackSetOperation - . - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property OperationId. - - The ID of the stack set operation. - - - - - - Gets and sets the property OperationPreferences. - - - - - Gets and sets the property StackSetName. - - The name of the stack set on which to perform the drift detection operation. - - - - - - This is the response object from the DetectStackSetDrift operation. - - - - - Gets and sets the property OperationId. - - The ID of the drift detection stack set operation. - - - - you can use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. - - - - - - Container for the parameters to the EstimateTemplateCost operation. - Returns the estimated monthly cost of a template. The return value is an AWS Simple - Monthly Calculator URL with a query string that describes the resources required to - run the template. - - - - - Gets and sets the property Parameters. - - A list of Parameter structures that specify input parameters. - - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body with a minimum length of 1 byte and a maximum - length of 51,200 bytes. (For more information, go to Template - Anatomy in the AWS CloudFormation User Guide.) - - - - Conditional: You must pass TemplateBody or TemplateURL. - If both are passed, only TemplateBody is used. - - - - - - Gets and sets the property TemplateURL. - - Location of file containing the template body. The URL must point to a template that - is located in an Amazon S3 bucket or a Systems Manager document. For more information, - go to Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must pass TemplateURL or TemplateBody. - If both are passed, only TemplateBody is used. - - - - - - The output for a EstimateTemplateCost action. - - - - - Gets and sets the property Url. - - An AWS Simple Monthly Calculator URL with a query string that describes the resources - required to run the template. - - - - - - Container for the parameters to the ExecuteChangeSet operation. - Updates a stack using the input information that was provided when the specified change - set was created. After the call successfully completes, AWS CloudFormation starts - updating the stack. Use the DescribeStacks action to view the status of the - update. - - - - When you execute a change set, AWS CloudFormation deletes all other change sets associated - with the stack because they aren't valid for the updated stack. - - - - If a stack policy is associated with the stack, AWS CloudFormation enforces the policy - during the update. You can't specify a temporary stack policy that overrides the current - policy. - - - - To create a change set for the entire stack hierachy, IncludeNestedStacks - must have been set to True. - - - - - - Gets and sets the property ChangeSetName. - - The name or ARN of the change set that you want use to update the specified stack. - - - - - - Gets and sets the property ClientRequestToken. - - A unique identifier for this ExecuteChangeSet request. Specify this token - if you plan to retry requests so that AWS CloudFormation knows that you're not attempting - to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet - requests to ensure that AWS CloudFormation successfully received them. - - - - - - Gets and sets the property StackName. - - If you specified the name of a change set, specify the stack name or ID (ARN) that - is associated with the change set you want to execute. - - - - - - The output for the ExecuteChangeSet action. - - - - - The Export structure describes the exported output values for a stack. - - - - - Gets and sets the property ExportingStackId. - - The stack that contains the exported output name and value. - - - - - - Gets and sets the property Name. - - The name of exported output value. Use this name and the Fn::ImportValue - function to import the associated value into other stacks. The name is defined in - the Export field in the associated stack's Outputs section. - - - - - - Gets and sets the property Value. - - The value of the exported output, such as a resource physical ID. This value is defined - in the Export field in the associated stack's Outputs section. - - - - - - Container for the parameters to the GetStackPolicy operation. - Returns the stack policy for a specified stack. If a stack doesn't have a policy, - a null value is returned. - - - - - Gets and sets the property StackName. - - The name or unique stack ID that is associated with the stack whose policy you want - to get. - - - - - - The output for the GetStackPolicy action. - - - - - Gets and sets the property StackPolicyBody. - - Structure containing the stack policy body. (For more information, go to - Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.) - - - - - - Container for the parameters to the GetTemplate operation. - Returns the template body for a specified stack. You can get the template for running - or deleted stacks. - - - - For deleted stacks, GetTemplate returns the template for up to 90 days after the stack - has been deleted. - - - - If the template does not exist, a ValidationError is returned. - - - - - - - Gets and sets the property ChangeSetName. - - The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation - returns the associated template. If you specify a name, you must also specify the - StackName. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - - - Gets and sets the property TemplateStage. - - For templates that include transforms, the stage of the template that AWS CloudFormation - returns. To get the user-submitted template, specify Original. To get - the template after AWS CloudFormation has processed all transforms, specify Processed. - - - - - If the template doesn't include transforms, Original and Processed - return the same template. By default, AWS CloudFormation specifies Processed. - - - - - - The output for GetTemplate action. - - - - - Gets and sets the property StagesAvailable. - - The stage of the template that you can retrieve. For stacks, the Original - and Processed templates are always available. For change sets, the Original - template is always available. After AWS CloudFormation finishes creating the change - set, the Processed template becomes available. - - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body. (For more information, go to Template - Anatomy in the AWS CloudFormation User Guide.) - - - - AWS CloudFormation returns the same template that was used when the stack was created. - - - - - - Container for the parameters to the GetTemplateSummary operation. - Returns information about a new or existing template. The GetTemplateSummary - action is useful for viewing parameter information, such as default parameter values - and parameter types, before you create or update a stack or stack set. - - - - You can use the GetTemplateSummary action when you submit a template, - or you can get template information for a stack set, or a running or deleted stack. - - - - For deleted stacks, GetTemplateSummary returns the template information - for up to 90 days after the stack has been deleted. If the template does not exist, - a ValidationError is returned. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property StackName. - - The name or the stack ID that is associated with the stack, which are not always interchangeable. - For running stacks, you can specify either the stack's name or its unique stack ID. - For deleted stack, you must specify the unique stack ID. - - - - Conditional: You must specify only one of the following parameters: StackName, - StackSetName, TemplateBody, or TemplateURL. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set from which the stack was created. - - - - Conditional: You must specify only one of the following parameters: StackName, - StackSetName, TemplateBody, or TemplateURL. - - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body with a minimum length of 1 byte and a maximum - length of 51,200 bytes. For more information about templates, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify only one of the following parameters: StackName, - StackSetName, TemplateBody, or TemplateURL. - - - - - - Gets and sets the property TemplateURL. - - Location of file containing the template body. The URL must point to a template (max - size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. - For more information about templates, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify only one of the following parameters: StackName, - StackSetName, TemplateBody, or TemplateURL. - - - - - - The output for the GetTemplateSummary action. - - - - - Gets and sets the property Capabilities. - - The capabilities found within the template. If your template contains IAM resources, - you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter - when you use the CreateStack or UpdateStack actions with your template; - otherwise, those actions return an InsufficientCapabilities error. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - - - - - - Gets and sets the property CapabilitiesReason. - - The list of resources that generated the values in the Capabilities response - element. - - - - - - Gets and sets the property DeclaredTransforms. - - A list of the transforms that are declared in the template. - - - - - - Gets and sets the property Description. - - The value that is defined in the Description property of the template. - - - - - - Gets and sets the property Metadata. - - The value that is defined for the Metadata property of the template. - - - - - - Gets and sets the property Parameters. - - A list of parameter declarations that describe various properties for each parameter. - - - - - - Gets and sets the property ResourceIdentifierSummaries. - - A list of resource identifier summaries that describe the target resources of an import - operation and the properties you can provide during the import to identify the target - resources. For example, BucketName is a possible identifier property - for an AWS::S3::Bucket resource. - - - - - - Gets and sets the property ResourceTypes. - - A list of all the template resource types that are defined in the template, such as - AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. - - - - - - Gets and sets the property Version. - - The AWS template format version, which identifies the capabilities of the template. - - - - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - - - Constructs a new InsufficientCapabilitiesException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InsufficientCapabilitiesException - - - - - - - Construct instance of InsufficientCapabilitiesException - - - - - - Construct instance of InsufficientCapabilitiesException - - - - - - - - - - - Construct instance of InsufficientCapabilitiesException - - - - - - - - - - Constructs a new instance of the InsufficientCapabilitiesException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Response Unmarshaller for AccountGateResult Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AccountLimit Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - ActivateType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ActivateType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AlreadyExistsException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AutoDeployment Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for BatchDescribeTypeConfigurationsError Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - BatchDescribeTypeConfigurations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for BatchDescribeTypeConfigurations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CancelUpdateStack Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CancelUpdateStack operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CFNRegistryException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ChangeSetNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ChangeSetSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Change Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - ContinueUpdateRollback Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ContinueUpdateRollback operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateChangeSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateChangeSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreatedButModifiedException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - CreateStackInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateStackInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateStack Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateStack operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateStackSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateStackSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeactivateType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeactivateType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteChangeSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteChangeSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteStackInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteStackInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteStack Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteStack operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteStackSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteStackSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeploymentTargets Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - DeregisterType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeregisterType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeAccountLimits Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeAccountLimits operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeChangeSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeChangeSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribePublisher Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribePublisher operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackDriftDetectionStatus Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackDriftDetectionStatus operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackEvents Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackEvents operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackInstance Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackInstance operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackResourceDrifts Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackResourceDrifts operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackResources Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackResources operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackSetOperation Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackSetOperation operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStackSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStackSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeStacks Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeStacks operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeTypeRegistration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeTypeRegistration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DetectStackDrift Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DetectStackDrift operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DetectStackResourceDrift Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DetectStackResourceDrift operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DetectStackSetDrift Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DetectStackSetDrift operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - EstimateTemplateCost Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EstimateTemplateCost operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ExecuteChangeSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ExecuteChangeSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Export Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - GetStackPolicy Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetStackPolicy operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetTemplate Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetTemplate operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetTemplateSummary Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetTemplateSummary operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InsufficientCapabilitiesException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidChangeSetStatusException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidOperationException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidStateTransitionException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for LimitExceededException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - ListChangeSets Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListChangeSets operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListExports Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListExports operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListImports Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListImports operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStackInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStackInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStackResources Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStackResources operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStackSetOperationResults Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStackSetOperationResults operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStackSetOperations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStackSetOperations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStackSets Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStackSets operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListStacks Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListStacks operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListTypeRegistrations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListTypeRegistrations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListTypes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListTypes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListTypeVersions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListTypeVersions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for LoggingConfig Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ModuleInfo Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for NameAlreadyExistsException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for OperationIdAlreadyExistsException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for OperationInProgressException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for OperationNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for OperationStatusCheckFailedException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Output Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ParameterConstraints Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ParameterDeclaration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Parameter Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PhysicalResourceIdContextKeyValuePair Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PropertyDifference Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - PublishType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PublishType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RecordHandlerProgress Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RecordHandlerProgress operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RegisterPublisher Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RegisterPublisher operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RegisterType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RegisterType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RequiredActivatedType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceChangeDetail Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceChange Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceIdentifierSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceTargetDefinition Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RollbackConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RollbackTrigger Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - SetStackPolicy Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetStackPolicy operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetTypeConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetTypeConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetTypeDefaultVersion Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetTypeDefaultVersion operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SignalResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SignalResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackDriftInformationSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackDriftInformation Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackEvent Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackInstanceComprehensiveStatus Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackInstanceNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackInstanceSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackInstance Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResourceDetail Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResourceDriftInformationSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResourceDriftInformation Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResourceDrift Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResourceSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackResource Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetDriftDetectionDetails Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetNotEmptyException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetOperationPreferences Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetOperationResultSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetOperationSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetOperation Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSetSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSet Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StackSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Stack Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StaleRequestException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - StopStackSetOperation Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StopStackSetOperation operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Tag Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TemplateParameter Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - TestType Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TestType operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TokenAlreadyExistsException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeConfigurationDetails Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeConfigurationIdentifier Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeConfigurationNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeNotFoundException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TypeVersionSummary Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - UpdateStackInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateStackInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateStack Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateStack operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateStackSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateStackSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateTerminationProtection Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateTerminationProtection operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ValidateTemplate Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ValidateTemplate operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - - - - Constructs a new InvalidChangeSetStatusException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidChangeSetStatusException - - - - - - - Construct instance of InvalidChangeSetStatusException - - - - - - Construct instance of InvalidChangeSetStatusException - - - - - - - - - - - Construct instance of InvalidChangeSetStatusException - - - - - - - - - - Constructs a new instance of the InvalidChangeSetStatusException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The specified operation isn't valid. - - - - - Constructs a new InvalidOperationException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidOperationException - - - - - - - Construct instance of InvalidOperationException - - - - - - Construct instance of InvalidOperationException - - - - - - - - - - - Construct instance of InvalidOperationException - - - - - - - - - - Constructs a new instance of the InvalidOperationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - - - Constructs a new InvalidStateTransitionException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidStateTransitionException - - - - - - - Construct instance of InvalidStateTransitionException - - - - - - Construct instance of InvalidStateTransitionException - - - - - - - - - - - Construct instance of InvalidStateTransitionException - - - - - - - - - - Constructs a new instance of the InvalidStateTransitionException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - - - Constructs a new LimitExceededException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of LimitExceededException - - - - - - - Construct instance of LimitExceededException - - - - - - Construct instance of LimitExceededException - - - - - - - - - - - Construct instance of LimitExceededException - - - - - - - - - - Constructs a new instance of the LimitExceededException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the ListChangeSets operation. - Returns the ID and status of each active change set for a stack. For example, AWS - CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - CREATE_PENDING state. - - - - - Gets and sets the property NextToken. - - A string (provided by the ListChangeSets response output) that identifies the - next page of change sets that you want to retrieve. - - - - - - Gets and sets the property StackName. - - The name or the Amazon Resource Name (ARN) of the stack for which you want to list - change sets. - - - - - - The output for the ListChangeSets action. - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB, a string that identifies the next page of change sets. - If there is no additional page, this value is null. - - - - - - Gets and sets the property Summaries. - - A list of ChangeSetSummary structures that provides the ID and status - of each change set for the specified stack. - - - - - - Container for the parameters to the ListExports operation. - Lists all exported output values in the account and Region in which you call this - action. Use this action to see the exported output values that you can import into - other stacks. To import values, use the - Fn::ImportValue function. - - - - For more information, see - AWS CloudFormation Export Stack Output Values. - - - - - - Gets and sets the property NextToken. - - A string (provided by the ListExports response output) that identifies the - next page of exported output values that you asked to retrieve. - - - - - - This is the response object from the ListExports operation. - - - - - Gets and sets the property Exports. - - The output for the ListExports action. - - - - - - Gets and sets the property NextToken. - - If the output exceeds 100 exported output values, a string that identifies the next - page of exports. If there is no additional page, this value is null. - - - - - - Container for the parameters to the ListImports operation. - Lists all stacks that are importing an exported output value. To modify or remove - an exported output value, first use this action to see which stacks are using it. - To see the exported output values in your account, see ListExports. - - - - For more information about importing an exported output value, see the - Fn::ImportValue function. - - - - - - Gets and sets the property ExportName. - - The name of the exported output value. AWS CloudFormation returns the stack names - that are importing this value. - - - - - - Gets and sets the property NextToken. - - A string (provided by the ListImports response output) that identifies the - next page of stacks that are importing the specified exported output value. - - - - - - This is the response object from the ListImports operation. - - - - - Gets and sets the property Imports. - - A list of stack names that are importing the specified exported output value. - - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of exports. If there is no additional page, - this value is null. - - - - - - Container for the parameters to the ListStackInstances operation. - Returns summary information about stack instances that are associated with the specified - stack set. You can filter for stack instances that are associated with a specific - AWS account name or Region, or that have a specific status. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property Filters. - - The status that stack instances are filtered by. - - - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous request didn't return all of the remaining results, the response's - NextToken parameter value is set to a token. To retrieve the next set - of results, call ListStackInstances again and assign that token to the - request object's NextToken parameter. If there are no remaining results, - the previous response object's NextToken parameter is set to null. - - - - - - Gets and sets the property StackInstanceAccount. - - The name of the AWS account that you want to list stack instances for. - - - - - - Gets and sets the property StackInstanceRegion. - - The name of the Region where you want to list stack instances. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to list stack instances for. - - - - - - This is the response object from the ListStackInstances operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call ListStackInstances - again and assign that token to the request object's NextToken parameter. - If the request returns all results, NextToken is set to null. - - - - - - Gets and sets the property Summaries. - - A list of StackInstanceSummary structures that contain information about - the specified stack instances. - - - - - - Container for the parameters to the ListStackResources operation. - Returns descriptions of all resources of the specified stack. - - - - For deleted stacks, ListStackResources returns resource information for up to 90 days - after the stack has been deleted. - - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of stack resources that you want to retrieve. - - - - - - Gets and sets the property StackName. - - The name or the unique stack ID that is associated with the stack, which are not always - interchangeable: - -
  • - - Running stacks: You can specify either the stack's name or its unique stack ID. - -
  • - - Deleted stacks: You must specify the unique stack ID. - -
- - Default: There is no default value. - - - - - - The output for a ListStackResources action. - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB, a string that identifies the next page of stack resources. - If no additional page exists, this value is null. - - - - - - Gets and sets the property StackResourceSummaries. - - A list of StackResourceSummary structures. - - - - - - Container for the parameters to the ListStackSetOperationResults operation. - Returns summary information about the results of a stack set operation. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous request didn't return all of the remaining results, the response object's - NextToken parameter value is set to a token. To retrieve the next set - of results, call ListStackSetOperationResults again and assign that token - to the request object's NextToken parameter. If there are no remaining - results, the previous response object's NextToken parameter is set to - null. - - - - - - Gets and sets the property OperationId. - - The ID of the stack set operation. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to get operation results for. - - - - - - This is the response object from the ListStackSetOperationResults operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all results, NextToken is set to a token. - To retrieve the next set of results, call ListOperationResults again - and assign that token to the request object's NextToken parameter. If - there are no remaining results, NextToken is set to null. - - - - - - Gets and sets the property Summaries. - - A list of StackSetOperationResultSummary structures that contain information - about the specified operation results, for accounts and Regions that are included - in the operation. - - - - - - Container for the parameters to the ListStackSetOperations operation. - Returns summary information about operations performed on a stack set. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous paginated request didn't return all of the remaining results, the - response object's NextToken parameter value is set to a token. To retrieve - the next set of results, call ListStackSetOperations again and assign - that token to the request object's NextToken parameter. If there are - no remaining results, the previous response object's NextToken parameter - is set to null. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to get operation summaries for. - - - - - - This is the response object from the ListStackSetOperations operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all results, NextToken is set to a token. - To retrieve the next set of results, call ListOperationResults again - and assign that token to the request object's NextToken parameter. If - there are no remaining results, NextToken is set to null. - - - - - - Gets and sets the property Summaries. - - A list of StackSetOperationSummary structures that contain summary information - about operations for the specified stack set. - - - - - - Container for the parameters to the ListStackSets operation. - Returns summary information about stack sets that are associated with the user. - -
  • - - [Self-managed permissions] If you set the CallAs parameter to SELF - while signed in to your AWS account, ListStackSets returns all self-managed - stack sets in your AWS account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to SELF - while signed in to the organization's management account, ListStackSets - returns all stack sets in the management account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN - while signed in to your member account, ListStackSets returns all stack - sets with service-managed permissions in the management account. - -
- - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the management account or as a delegated administrator in a member account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous paginated request didn't return all of the remaining results, the - response object's NextToken parameter value is set to a token. To retrieve - the next set of results, call ListStackSets again and assign that token - to the request object's NextToken parameter. If there are no remaining - results, the previous response object's NextToken parameter is set to - null. - - - - - - Gets and sets the property Status. - - The status of the stack sets that you want to get summary information about. - - - - - - This is the response object from the ListStackSets operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call ListStackInstances - again and assign that token to the request object's NextToken parameter. - If the request returns all results, NextToken is set to null. - - - - - - Gets and sets the property Summaries. - - A list of StackSetSummary structures that contain information about the - user's stack sets. - - - - - - Container for the parameters to the ListStacks operation. - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - - - - Gets and sets the property NextToken. - - A string that identifies the next page of stacks that you want to retrieve. - - - - - - Gets and sets the property StackStatusFilter. - - Stack status to use as a filter. Specify one or more stack status codes to list only - stacks with the specified status codes. For a complete list of stack status codes, - see the StackStatus parameter of the Stack data type. - - - - - - The output for ListStacks action. - - - - - Gets and sets the property NextToken. - - If the output exceeds 1 MB in size, a string that identifies the next page of stacks. - If no additional page exists, this value is null. - - - - - - Gets and sets the property StackSummaries. - - A list of StackSummary structures containing information about the specified - stacks. - - - - - - Container for the parameters to the ListTypeRegistrations operation. - Returns a list of registration tokens for the specified extension(s). - - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous paginated request didn't return all of the remaining results, the - response object's NextToken parameter value is set to a token. To retrieve - the next set of results, call this action again and assign that token to the request - object's NextToken parameter. If there are no remaining results, the - previous response object's NextToken parameter is set to null. - - - - - - Gets and sets the property RegistrationStatusFilter. - - The current status of the extension registration request. - - - - The default is IN_PROGRESS. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - This is the response object from the ListTypeRegistrations operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call this action again and - assign that token to the request object's NextToken parameter. If the - request returns all results, NextToken is set to null. - - - - - - Gets and sets the property RegistrationTokenList. - - A list of extension registration tokens. - - - - Use DescribeTypeRegistration to return detailed information - about a type registration request. - - - - - - Container for the parameters to the ListTypes operation. - Returns summary information about extension that have been registered with CloudFormation. - - - - - Gets and sets the property DeprecatedStatus. - - The deprecation status of the extension that you want to get summary information about. - - - - Valid values include: - -
  • - - LIVE: The extension is registered for use in CloudFormation operations. - -
  • - - DEPRECATED: The extension has been deregistered and can no longer be - used in CloudFormation operations. - -
- - - - - Gets and sets the property Filters. - - Filter criteria to use in determining which extensions to return. - - - - If you specify a filter, CloudFormation ignores any specified Visibility - value when returning the list of types. - - - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous paginated request didn't return all of the remaining results, the - response object's NextToken parameter value is set to a token. To retrieve - the next set of results, call this action again and assign that token to the request - object's NextToken parameter. If there are no remaining results, the - previous response object's NextToken parameter is set to null. - - - - - - Gets and sets the property ProvisioningType. - - For resource types, the provisioning behavior of the resource type. AWS CloudFormation - determines the provisioning type during registration, based on the types of handlers - in the schema handler package submitted. - - - - Valid values include: - -
  • - - FULLY_MUTABLE: The resource type includes an update handler to process - updates to the type during stack update operations. - -
  • - - IMMUTABLE: The resource type does not include an update handler, so - the type cannot be updated and must instead be replaced during stack update operations. - -
  • - - NON_PROVISIONABLE: The resource type does not include create, read, - and delete handlers, and therefore cannot actually be provisioned. - -
- - The default is FULLY_MUTABLE. - - - - - - Gets and sets the property Type. - - The type of extension. - - - - - - Gets and sets the property Visibility. - - The scope at which the extensions are visible and usable in CloudFormation operations. - - - - Valid values include: - -
  • - - PRIVATE: Extensions that are visible and usable within this account - and region. This includes: - -
    • - - Private extensions you have registered in this account and region. - -
    • - - Public extensions that you have activated in this account and region. - -
  • - - PUBLIC: Extensions that are publicly visible and available to be activated - within any Amazon account. This includes extensions from Amazon, as well as third-party - publishers. - -
- - The default is PRIVATE. - - - - - - This is the response object from the ListTypes operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call this action again and - assign that token to the request object's NextToken parameter. If the - request returns all results, NextToken is set to null. - - - - - - Gets and sets the property TypeSummaries. - - A list of TypeSummary structures that contain information about the specified - extensions. - - - - - - Container for the parameters to the ListTypeVersions operation. - Returns summary information about the versions of an extension. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension for which you want version summary - information. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property DeprecatedStatus. - - The deprecation status of the extension versions that you want to get summary information - about. - - - - Valid values include: - -
  • - - LIVE: The extension version is registered and can be used in CloudFormation - operations, dependent on its provisioning behavior and visibility scope. - -
  • - - DEPRECATED: The extension version has been deregistered and can no longer - be used in CloudFormation operations. - -
- - The default is LIVE. - - - - - - Gets and sets the property MaxResults. - - The maximum number of results to be returned with a single call. If the number of - available results exceeds this maximum, the response includes a NextToken - value that you can assign to the NextToken request parameter to get the - next set of results. - - - - - - Gets and sets the property NextToken. - - If the previous paginated request didn't return all of the remaining results, the - response object's NextToken parameter value is set to a token. To retrieve - the next set of results, call this action again and assign that token to the request - object's NextToken parameter. If there are no remaining results, the - previous response object's NextToken parameter is set to null. - - - - - - Gets and sets the property PublisherId. - - The publisher ID of the extension publisher. - - - - Extensions published by Amazon are not assigned a publisher ID. - - - - - - Gets and sets the property Type. - - The kind of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeName. - - The name of the extension for which you want version summary information. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - This is the response object from the ListTypeVersions operation. - - - - - Gets and sets the property NextToken. - - If the request doesn't return all of the remaining results, NextToken - is set to a token. To retrieve the next set of results, call this action again and - assign that token to the request object's NextToken parameter. If the - request returns all results, NextToken is set to null. - - - - - - Gets and sets the property TypeVersionSummaries. - - A list of TypeVersionSummary structures that contain information about - the specified extension's versions. - - - - - - Contains logging configuration information for an extension. - - - - - Gets and sets the property LogGroupName. - - The Amazon CloudWatch log group to which CloudFormation sends error logging information - when invoking the extension's handlers. - - - - - - Gets and sets the property LogRoleArn. - - The ARN of the role that CloudFormation should assume when sending log entries to - CloudWatch logs. - - - - - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - For more information on modules, see Using - modules to encapsulate and reuse resource configurations in the CloudFormation - User Guide. - - - - - - Gets and sets the property LogicalIdHierarchy. - - A concantenated list of the logical IDs of the module or modules containing the resource. - Modules are listed starting with the inner-most nested module, and separated by /. - - - - In the following example, the resource was created from a module, moduleA, - that is nested inside a parent module, moduleB. - - - - moduleA/moduleB - - - - For more information, see Referencing - resources in a module in the CloudFormation User Guide. - - - - - - Gets and sets the property TypeHierarchy. - - A concantenated list of the the module type or types containing the resource. Module - types are listed starting with the inner-most nested module, and separated by /. - - - - In the following example, the resource was created from a module of type AWS::First::Example::MODULE, - that is nested inside a parent module of type AWS::Second::Example::MODULE. - - - - AWS::First::Example::MODULE/AWS::Second::Example::MODULE - - - - - - The specified name is already in use. - - - - - Constructs a new NameAlreadyExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of NameAlreadyExistsException - - - - - - - Construct instance of NameAlreadyExistsException - - - - - - Construct instance of NameAlreadyExistsException - - - - - - - - - - - Construct instance of NameAlreadyExistsException - - - - - - - - - - Constructs a new instance of the NameAlreadyExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The specified operation ID already exists. - - - - - Constructs a new OperationIdAlreadyExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of OperationIdAlreadyExistsException - - - - - - - Construct instance of OperationIdAlreadyExistsException - - - - - - Construct instance of OperationIdAlreadyExistsException - - - - - - - - - - - Construct instance of OperationIdAlreadyExistsException - - - - - - - - - - Constructs a new instance of the OperationIdAlreadyExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - - - Constructs a new OperationInProgressException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of OperationInProgressException - - - - - - - Construct instance of OperationInProgressException - - - - - - Construct instance of OperationInProgressException - - - - - - - - - - - Construct instance of OperationInProgressException - - - - - - - - - - Constructs a new instance of the OperationInProgressException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The specified ID refers to an operation that doesn't exist. - - - - - Constructs a new OperationNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of OperationNotFoundException - - - - - - - Construct instance of OperationNotFoundException - - - - - - Construct instance of OperationNotFoundException - - - - - - - - - - - Construct instance of OperationNotFoundException - - - - - - - - - - Constructs a new instance of the OperationNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - - - Constructs a new OperationStatusCheckFailedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of OperationStatusCheckFailedException - - - - - - - Construct instance of OperationStatusCheckFailedException - - - - - - Construct instance of OperationStatusCheckFailedException - - - - - - - - - - - Construct instance of OperationStatusCheckFailedException - - - - - - - - - - Constructs a new instance of the OperationStatusCheckFailedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The Output data type. - - - - - Gets and sets the property Description. - - User defined description associated with the output. - - - - - - Gets and sets the property ExportName. - - The name of the export associated with the output. - - - - - - Gets and sets the property OutputKey. - - The key associated with the output. - - - - - - Gets and sets the property OutputValue. - - The value associated with the output. - - - - - - The Parameter data type. - - - - - Gets and sets the property ParameterKey. - - The key associated with the parameter. If you don't specify a key and value for a - particular parameter, AWS CloudFormation uses the default value that is specified - in your template. - - - - - - Gets and sets the property ParameterValue. - - The input value associated with the parameter. - - - - - - Gets and sets the property ResolvedValue. - - Read-only. The value that corresponds to a Systems Manager parameter key. This field - is returned only for - SSM parameter types in the template. - - - - - - Gets and sets the property UsePreviousValue. - - During a stack update, use the existing parameter value that the stack is using for - a given parameter key. If you specify true, do not specify a parameter - value. - - - - - - A set of criteria that AWS CloudFormation uses to validate parameter values. Although - other constraints might be defined in the stack template, AWS CloudFormation returns - only the AllowedValues property. - - - - - Gets and sets the property AllowedValues. - - A list of values that are permitted for a parameter. - - - - - - The ParameterDeclaration data type. - - - - - Gets and sets the property DefaultValue. - - The default value of the parameter. - - - - - - Gets and sets the property Description. - - The description that is associate with the parameter. - - - - - - Gets and sets the property NoEcho. - - Flag that indicates whether the parameter value is shown as plain text in logs and - in the AWS Management Console. - - - - - - Gets and sets the property ParameterConstraints. - - The criteria that AWS CloudFormation uses to validate parameter values. - - - - - - Gets and sets the property ParameterKey. - - The name that is associated with the parameter. - - - - - - Gets and sets the property ParameterType. - - The type of parameter. - - - - - - Context information that enables AWS CloudFormation to uniquely identify a resource. - AWS CloudFormation uses context key-value pairs in cases where a resource's logical - and physical IDs are not enough to uniquely identify that resource. Each context key-value - pair specifies a resource that contains the targeted resource. - - - - - Gets and sets the property Key. - - The resource context key. - - - - - - Gets and sets the property Value. - - The resource context value. - - - - - - Information about a resource property whose actual value differs from its expected - value, as defined in the stack template and any values specified as template parameters. - These will be present only for resources whose StackResourceDriftStatus - is MODIFIED. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - Gets and sets the property ActualValue. - - The actual property value of the resource property. - - - - - - Gets and sets the property DifferenceType. - - The type of property difference. - -
  • - - ADD: A value has been added to a resource property that is an array - or list data type. - -
  • - - REMOVE: The property has been removed from the current resource configuration. - -
  • - - NOT_EQUAL: The current property value differs from its expected value - (as defined in the stack template and any values specified as template parameters). - -
- - - - - Gets and sets the property ExpectedValue. - - The expected property value of the resource property, as defined in the stack template - and any values specified as template parameters. - - - - - - Gets and sets the property PropertyPath. - - The fully-qualified path to the resource property. - - - - - - Container for the parameters to the PublishType operation. - Publishes the specified extension to the CloudFormation registry as a public extension - in this region. Public extensions are available for use by all CloudFormation users. - For more information on publishing extensions, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - To publish an extension, you must be registered as a publisher with CloudFormation. - For more information, see RegisterPublisher. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Number (ARN) of the extension. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - Gets and sets the property PublicVersionNumber. - - The version number to assign to this version of the extension. - - - - Use the following format, and adhere to semantic versioning when assigning a version - number to your extension: - - - - MAJOR.MINOR.PATCH - - - - For more information, see Semantic Versioning 2.0.0. - - - - If you do not specify a version number, CloudFormation increments the version number - by one minor version release. - - - - - - Gets and sets the property Type. - - The type of the extension. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - This is the response object from the PublishType operation. - - - - - Gets and sets the property PublicTypeArn. - - The Amazon Resource Number (ARN) assigned to the public extension upon publication. - - - - - - Container for the parameters to the RecordHandlerProgress operation. - Reports progress of a resource handler to CloudFormation. - - - - Reserved for use by the CloudFormation - CLI. Do not use this API in your code. - - - - - - Gets and sets the property BearerToken. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property ClientRequestToken. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property CurrentOperationStatus. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property ErrorCode. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property OperationStatus. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property ResourceModel. - - Reserved for use by the CloudFormation - CLI. - - - - - - Gets and sets the property StatusMessage. - - Reserved for use by the CloudFormation - CLI. - - - - - - This is the response object from the RecordHandlerProgress operation. - - - - - Container for the parameters to the RegisterPublisher operation. - Registers your account as a publisher of public extensions in the CloudFormation registry. - Public extensions are available for use by all CloudFormation users. This publisher - ID applies to your account in all AWS regions. - - - - For information on requirements for registering as a public extension publisher, see - Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - - - - Gets and sets the property AcceptTermsAndConditions. - - Whether you accept the terms and conditions for publishing extensions in the CloudFormation - registry. You must accept the terms and conditions in order to register to publish - public extensions to the CloudFormation registry. - - - - The default is false. - - - - - - Gets and sets the property ConnectionArn. - - If you are using a Bitbucket or GitHub account for identity verification, the Amazon - Resource Name (ARN) for your connection to that account. - - - - For more information, see Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - - - - This is the response object from the RegisterPublisher operation. - - - - - Gets and sets the property PublisherId. - - The ID assigned this account by CloudFormation for publishing extensions. - - - - - - Container for the parameters to the RegisterType operation. - Registers an extension with the CloudFormation service. Registering an extension makes - it available for use in CloudFormation templates in your AWS account, and includes: - -
  • - - Validating the extension schema - -
  • - - Determining which handlers, if any, have been specified for the extension - -
  • - - Making the extension available for use in your account - -
- - For more information on how to develop extensions and ready them for registeration, - see Creating - Resource Providers in the CloudFormation CLI User Guide. - - - - You can have a maximum of 50 resource extension versions registered at a time. This - maximum is per account and per region. Use DeregisterType - to deregister specific extension versions if necessary. - - - - Once you have initiated a registration request using RegisterType , - you can use DescribeTypeRegistration to monitor the progress - of the registration request. - - - - Once you have registered a private extension in your account and region, use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - - - Gets and sets the property ClientRequestToken. - - A unique identifier that acts as an idempotency key for this registration request. - Specifying a client request token prevents CloudFormation from generating more than - one version of an extension from the same registeration request, even if the request - is submitted multiple times. - - - - - - Gets and sets the property ExecutionRoleArn. - - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking - the extension. - - - - For CloudFormation to assume the specified execution role, the role must contain a - trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). - For more information on adding trust relationships, see Modifying - a role trust policy in the AWS Identity and Access Management User Guide. - - - - If your extension calls AWS APIs in any of its handlers, you must create an IAM execution - role that includes the necessary permissions to call those AWS APIs, and - provision that execution role in your account. When CloudFormation needs to invoke - the resource type handler, CloudFormation assumes this execution role to create a - temporary session token, which it then passes to the resource type handler, thereby - supplying your resource type with the appropriate credentials. - - - - - - Gets and sets the property LoggingConfig. - - Specifies logging configuration information for an extension. - - - - - - Gets and sets the property SchemaHandlerPackage. - - A url to the S3 bucket containing the extension project package that contains the - neccessary files for the extension you want to register. - - - - For information on generating a schema handler package for the extension you want - to register, see submit - in the CloudFormation CLI User Guide. - - - - The user registering the extension must be able to access the package in the S3 bucket. - That is, the user needs to have GetObject - permissions for the schema handler package. For more information, see Actions, - Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access - Management User Guide. - - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - - - Gets and sets the property TypeName. - - The name of the extension being registered. - - - - We recommend that extension names adhere to the following patterns: - -
  • - - For resource types, company_or_organization::service::type. - -
  • - - For modules, company_or_organization::service::type::MODULE. - -
- - The following organization namespaces are reserved and cannot be used in your extension - names: - -
  • - - Alexa - -
  • - - AMZN - -
  • - - Amazon - -
  • - - AWS - -
  • - - Custom - -
  • - - Dev - -
- - - - - This is the response object from the RegisterType operation. - - - - - Gets and sets the property RegistrationToken. - - The identifier for this registration request. - - - - Use this registration token when calling DescribeTypeRegistration , - which returns information about the status and IDs of the extension registration. - - - - - - - For extensions that are modules, a public third-party extension that must be activated - in your account in order for the module itself to be activated. - - - - For more information, see Activating - public modules for use in your account in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property OriginalTypeName. - - The type name of the public extension. - - - - If you specified a TypeNameAlias when enabling the extension in this - account and region, CloudFormation treats that alias as the extension's type name - within the account and region, not the type name of the public extension. For more - information, see Specifying - aliases to refer to extensions in the CloudFormation User Guide. - - - - - - Gets and sets the property PublisherId. - - The publisher ID of the extension publisher. - - - - - - Gets and sets the property SupportedMajorVersions. - - A list of the major versions of the extension type that the macro supports. - - - - - - Gets and sets the property TypeNameAlias. - - An alias assigned to the public extension, in this account and region. If you specify - an alias for the extension, CloudFormation treats the alias as the extension type - name within this account and region. You must use the alias to refer to the extension - in your templates, API calls, and CloudFormation console. - - - - - - The ResourceChange structure describes the resource and the action that - AWS CloudFormation will perform on it if you execute this change set. - - - - - Gets and sets the property Action. - - The action that AWS CloudFormation takes on the resource, such as Add - (adds a new resource), Modify (changes a resource), Remove - (deletes a resource), Import (imports a resource), or Dynamic - (exact action for the resource cannot be determined). - - - - - - Gets and sets the property ChangeSetId. - - The change set ID of the nested change set. - - - - - - Gets and sets the property Details. - - For the Modify action, a list of ResourceChangeDetail structures - that describes the changes that AWS CloudFormation will make to the resource. - - - - - - Gets and sets the property LogicalResourceId. - - The resource's logical ID, which is defined in the stack's template. - - - - - - Gets and sets the property ModuleInfo. - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - - - Gets and sets the property PhysicalResourceId. - - The resource's physical ID (resource name). Resources that you are adding don't have - physical IDs because they haven't been created. - - - - - - Gets and sets the property Replacement. - - For the Modify action, indicates whether AWS CloudFormation will replace - the resource by creating a new one and deleting the old one. This value depends on - the value of the RequiresRecreation property in the ResourceTargetDefinition - structure. For example, if the RequiresRecreation field is Always - and the Evaluation field is Static, Replacement - is True. If the RequiresRecreation field is Always - and the Evaluation field is Dynamic, Replacement - is Conditionally. - - - - If you have multiple changes with different RequiresRecreation values, - the Replacement value depends on the change with the most impact. A RequiresRecreation - value of Always has the most impact, followed by Conditionally, - and then Never. - - - - - - Gets and sets the property ResourceType. - - The type of AWS CloudFormation resource, such as AWS::S3::Bucket. - - - - - - Gets and sets the property Scope. - - For the Modify action, indicates which resource attribute is triggering - this update, such as a change in the resource attribute's Metadata, Properties, - or Tags. - - - - - - For a resource with Modify as the action, the ResourceChange - structure describes the changes AWS CloudFormation will make to that resource. - - - - - Gets and sets the property CausingEntity. - - The identity of the entity that triggered this change. This entity is a member of - the group that is specified by the ChangeSource field. For example, if - you modified the value of the KeyPairName parameter, the CausingEntity - is the name of the parameter (KeyPairName). - - - - If the ChangeSource value is DirectModification, no value - is given for CausingEntity. - - - - - - Gets and sets the property ChangeSource. - - The group to which the CausingEntity value belongs. There are five entity - groups: - -
  • - - ResourceReference entities are Ref intrinsic functions - that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" - }. - -
  • - - ParameterReference entities are Ref intrinsic functions - that get template parameter values, such as { "Ref" : "MyPasswordParameter" - }. - -
  • - - ResourceAttribute entities are Fn::GetAtt intrinsic functions - that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", - "PublicDnsName" ] }. - -
  • - - DirectModification entities are changes that are made directly to the - template. - -
  • - - Automatic entities are AWS::CloudFormation::Stack resource - types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack - resource, AWS CloudFormation sets the ChangeSource to Automatic - because the nested stack's template might have changed. Changes to a nested stack's - template aren't visible to AWS CloudFormation until you run an update on the parent - stack. - -
- - - - - Gets and sets the property Evaluation. - - Indicates whether AWS CloudFormation can determine the target value, and whether the - target value will change before you execute a change set. - - - - For Static evaluations, AWS CloudFormation can determine that the target - value will change, and its value. For example, if you directly modify the InstanceType - property of an EC2 instance, AWS CloudFormation knows that this property value will - change, and its value, so this is a Static evaluation. - - - - For Dynamic evaluations, cannot determine the target value because it - depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt - intrinsic function, when the stack is updated. For example, if your template includes - a reference to a resource that is conditionally recreated, the value of the reference - (the physical ID of the resource) might change, depending on if the resource is recreated. - If the resource is recreated, it will have a new physical ID, so all references to - that resource will also be updated. - - - - - - Gets and sets the property Target. - - A ResourceTargetDefinition structure that describes the field that AWS - CloudFormation will change and whether the resource will be recreated. - - - - - - Describes the target resources of a specific type in your import template (for example, - all AWS::S3::Bucket resources) and the properties you can provide during - the import to identify resources of that type. - - - - - Gets and sets the property LogicalResourceIds. - - The logical IDs of the target resources of the specified ResourceType, - as defined in the import template. - - - - - - Gets and sets the property ResourceIdentifiers. - - The resource properties you can provide during the import to identify your target - resources. For example, BucketName is a possible identifier property - for AWS::S3::Bucket resources. - - - - - - Gets and sets the property ResourceType. - - The template resource type of the target resources, such as AWS::S3::Bucket. - - - - - - The field that AWS CloudFormation will change, such as the name of a resource's property, - and whether the resource will be recreated. - - - - - Gets and sets the property Attribute. - - Indicates which resource attribute is triggering this update, such as a change in - the resource attribute's Metadata, Properties, or Tags. - - - - - - Gets and sets the property Name. - - If the Attribute value is Properties, the name of the property. - For all other attributes, the value is null. - - - - - - Gets and sets the property RequiresRecreation. - - If the Attribute value is Properties, indicates whether - a change to this property causes the resource to be recreated. The value can be Never, - Always, or Conditionally. To determine the conditions for - a Conditionally recreation, see the update behavior for that property - in the AWS CloudFormation User Guide. - - - - - - Describes the target resource of an import operation. - - - - - Gets and sets the property LogicalResourceId. - - The logical ID of the target resource as specified in the template. - - - - - - Gets and sets the property ResourceIdentifier. - - A key-value pair that identifies the target resource. The key is an identifier property - (for example, BucketName for AWS::S3::Bucket resources) - and the value is the actual property value (for example, MyS3Bucket). - - - - - - Gets and sets the property ResourceType. - - The type of resource to import into your stack, such as AWS::S3::Bucket. - For a list of supported resource types, see Resources - that support import operations in the AWS CloudFormation User Guide. - - - - - - Structure containing the rollback triggers for AWS CloudFormation to monitor during - stack creation and updating operations, and for the specified monitoring period afterwards. - - - - Rollback triggers enable you to have AWS CloudFormation monitor the state of your - application during stack creation and updating, and to roll back that operation if - the application breaches the threshold of any of the alarms you've specified. For - more information, see Monitor - and Roll Back Stack Operations. - - - - - - Gets and sets the property MonitoringTimeInMinutes. - - The amount of time, in minutes, during which CloudFormation should monitor all the - rollback triggers after the stack creation or update operation deploys all necessary - resources. - - - - The default is 0 minutes. - - - - If you specify a monitoring period but do not specify any rollback triggers, CloudFormation - still waits the specified period of time before cleaning up old resources after update - operations. You can use this monitoring period to perform any manual stack validation - desired, and manually cancel the stack creation or update (using CancelUpdateStack, - for example) as necessary. - - - - If you specify 0 for this parameter, CloudFormation still monitors the specified rollback - triggers during stack creation and update operations. Then, for update operations, - it begins disposing of old resources immediately once the operation completes. - - - - - - Gets and sets the property RollbackTriggers. - - The triggers to monitor during stack creation or update actions. - - - - By default, AWS CloudFormation saves the rollback triggers specified for a stack and - applies them to any subsequent update operations for the stack, unless you specify - otherwise. If you do specify rollback triggers for this parameter, those triggers - replace any list of triggers previously specified for the stack. This means: - -
  • - - To use the rollback triggers previously specified for this stack, if any, don't specify - this parameter. - -
  • - - To specify new or updated rollback triggers, you must specify all the triggers - that you want used for this stack, even triggers you've specifed before (for example, - when creating the stack or during a previous stack update). Any triggers that you - don't include in the updated list of triggers are no longer applied to the stack. - -
  • - - To remove all currently specified triggers, specify an empty list for this parameter. - -
- - If a specified trigger is missing, the entire stack operation fails and is rolled - back. - - - - - - A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. - If any of the alarms you specify goes to ALARM state during the stack operation or - within the specified monitoring period afterwards, CloudFormation rolls back the entire - stack operation. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the rollback trigger. - - - - If a specified trigger is missing, the entire stack operation fails and is rolled - back. - - - - - - Gets and sets the property Type. - - The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm - is the only supported resource type. - - - - - - Container for the parameters to the SetStackPolicy operation. - Sets a stack policy for a specified stack. - - - - - Gets and sets the property StackName. - - The name or unique stack ID that you want to associate a policy with. - - - - - - Gets and sets the property StackPolicyBody. - - Structure containing the stack policy body. For more information, go to - Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can - specify either the StackPolicyBody or the StackPolicyURL - parameter, but not both. - - - - - - Gets and sets the property StackPolicyURL. - - Location of a file containing the stack policy. The URL must point to a policy (maximum - size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify - either the StackPolicyBody or the StackPolicyURL parameter, - but not both. - - - - - - This is the response object from the SetStackPolicy operation. - - - - - Container for the parameters to the SetTypeConfiguration operation. - Specifies the configuration data for a registered CloudFormation extension, in the - given account and region. - - - - To view the current configuration data for an extension, refer to the ConfigurationSchema - element of DescribeType. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - It is strongly recommended that you use dynamic references to restrict sensitive configuration - definitions, such as third-party credentials. For more details on dynamic references, - see Using dynamic references to specify template - values in the AWS CloudFormation User Guide. - - - - - - - Gets and sets the property Configuration. - - The configuration data for the extension, in this account and region. - - - - The configuration data must be formatted as JSON, and validate against the schema - returned in the ConfigurationSchema response element of API_DescribeType. - For more information, see Defining - account-level configuration data for an extension in the CloudFormation CLI - User Guide. - - - - - - Gets and sets the property ConfigurationAlias. - - An alias by which to refer to this extension configuration data. - - - - Conditional: Specifying a configuration alias is required when setting a configuration - for a resource type extension. - - - - - - Gets and sets the property Type. - - The type of extension. - - - - Conditional: You must specify ConfigurationArn, or Type - and TypeName. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) for the extension, in this account and region. - - - - For public extensions, this will be the ARN assigned when you activate - the type in this account and region. For private extensions, this will be the - ARN assigned when you register - the type in this account and region. - - - - Do not include the extension versions suffix at the end of the ARN. You can set the - configuration for an extension, but not for a specific extension version. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify ConfigurationArn, or Type - and TypeName. - - - - - - This is the response object from the SetTypeConfiguration operation. - - - - - Gets and sets the property ConfigurationArn. - - The Amazon Resource Name (ARN) for the configuration data, in this account and region. - - - - Conditional: You must specify ConfigurationArn, or Type - and TypeName. - - - - - - Container for the parameters to the SetTypeDefaultVersion operation. - Specify the default version of an extension. The default version of an extension will - be used in CloudFormation operations. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension for which you want version summary - information. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - Conditional: You must specify either TypeName and Type, - or Arn. - - - - - - Gets and sets the property VersionId. - - The ID of a specific version of the extension. The version ID is the value at the - end of the Amazon Resource Name (ARN) assigned to the extension version when it is - registered. - - - - - - This is the response object from the SetTypeDefaultVersion operation. - - - - - Container for the parameters to the SignalResource operation. - Sends a signal to the specified resource with a success or failure status. You can - use the SignalResource API in conjunction with a creation policy or update policy. - AWS CloudFormation doesn't proceed with a stack creation or update until resources - receive the required number of signals or the timeout period is exceeded. The SignalResource - API is useful in cases where you want to send signals from anywhere other than an - Amazon EC2 instance. - - - - - Gets and sets the property LogicalResourceId. - - The logical ID of the resource that you want to signal. The logical ID is the name - of the resource that given in the template. - - - - - - Gets and sets the property StackName. - - The stack name or unique stack ID that includes the resource that you want to signal. - - - - - - Gets and sets the property Status. - - The status of the signal, which is either success or failure. A failure signal causes - AWS CloudFormation to immediately fail the stack creation or update. - - - - - - Gets and sets the property UniqueId. - - A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, - specify the instance ID that you are signaling as the unique ID. If you send multiple - signals to a single resource (such as signaling a wait condition), each signal requires - a different unique ID. - - - - - - This is the response object from the SignalResource operation. - - - - - The Stack data type. - - - - - Gets and sets the property Capabilities. - - The capabilities allowed in the stack. - - - - - - Gets and sets the property ChangeSetId. - - The unique ID of the change set. - - - - - - Gets and sets the property CreationTime. - - The time at which the stack was created. - - - - - - Gets and sets the property DeletionTime. - - The time the stack was deleted. - - - - - - Gets and sets the property Description. - - A user-defined description associated with the stack. - - - - - - Gets and sets the property DisableRollback. - - Boolean to enable or disable rollback on stack creation failures: - -
  • - - true: disable rollback - -
  • - - false: enable rollback - -
- - - - - Gets and sets the property DriftInformation. - - Information on whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - - Gets and sets the property EnableTerminationProtection. - - Whether termination protection is enabled for the stack. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property LastUpdatedTime. - - The time the stack was last updated. This field will only be returned if the stack - has been updated at least once. - - - - - - Gets and sets the property NotificationARNs. - - SNS topic ARNs to which stack related events are published. - - - - - - Gets and sets the property Outputs. - - A list of output structures. - - - - - - Gets and sets the property Parameters. - - A list of Parameter structures. - - - - - - Gets and sets the property ParentId. - - For nested stacks--stacks created as resources for another stack--the stack ID of - the direct parent of this stack. For the first level of nested stacks, the root stack - is also the parent stack. - - - - For more information, see Working - with Nested Stacks in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property RoleARN. - - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role - that is associated with the stack. During a stack operation, AWS CloudFormation uses - this role's credentials to make calls on your behalf. - - - - - - Gets and sets the property RollbackConfiguration. - - The rollback triggers for AWS CloudFormation to monitor during stack creation and - updating operations, and for the specified monitoring period afterwards. - - - - - - Gets and sets the property RootId. - - For nested stacks--stacks created as resources for another stack--the stack ID of - the top-level stack to which the nested stack ultimately belongs. - - - - For more information, see Working - with Nested Stacks in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property StackId. - - Unique identifier of the stack. - - - - - - Gets and sets the property StackName. - - The name associated with the stack. - - - - - - Gets and sets the property StackStatus. - - Current status of the stack. - - - - - - Gets and sets the property StackStatusReason. - - Success/failure message associated with the stack status. - - - - - - Gets and sets the property Tags. - - A list of Tags that specify information about the stack. - - - - - - Gets and sets the property TimeoutInMinutes. - - The amount of time within which stack creation should complete. - - - - - - Contains information about whether the stack's actual configuration differs, or has - drifted, from its expected configuration, as defined in the stack template - and any values specified as template parameters. A stack is considered to have drifted - if one or more of its resources have drifted. - - - - - Gets and sets the property LastCheckTimestamp. - - Most recent time when a drift detection operation was initiated on the stack, or any - of its individual resources that support drift detection. - - - - - - Gets and sets the property StackDriftStatus. - - Status of the stack's actual configuration compared to its expected template configuration. - - -
  • - - DRIFTED: The stack differs from its expected template configuration. - A stack is considered to have drifted if one or more of its resources have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the stack differs - from its expected template configuration. - -
  • - - IN_SYNC: The stack's actual configuration matches its expected template - configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - Contains information about whether the stack's actual configuration differs, or has - drifted, from its expected configuration, as defined in the stack template - and any values specified as template parameters. A stack is considered to have drifted - if one or more of its resources have drifted. - - - - - Gets and sets the property LastCheckTimestamp. - - Most recent time when a drift detection operation was initiated on the stack, or any - of its individual resources that support drift detection. - - - - - - Gets and sets the property StackDriftStatus. - - Status of the stack's actual configuration compared to its expected template configuration. - - -
  • - - DRIFTED: The stack differs from its expected template configuration. - A stack is considered to have drifted if one or more of its resources have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the stack differs - from its expected template configuration. - -
  • - - IN_SYNC: The stack's actual configuration matches its expected template - configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - The StackEvent data type. - - - - - Gets and sets the property ClientRequestToken. - - The token passed to the operation that generated this event. - - - - All events triggered by a given stack operation are assigned the same client request - token, which you can use to track operations. For example, if you execute a CreateStack - operation with the token token1, then all the StackEvents - generated by that operation will have ClientRequestToken set as token1. - - - - In the console, stack operations display the client request token on the Events tab. - Stack operations that are initiated from the console use the token format Console-StackOperation-ID, - which helps you easily identify the stack operation . For example, if you create a - stack using the console, each stack event would be assigned the same token in the - following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. - - - - - - - Gets and sets the property EventId. - - The unique ID of this event. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource specified in the template. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier associated with the physical instance of the resource. - - - - - - Gets and sets the property ResourceProperties. - - BLOB of the properties used to create the resource. - - - - - - Gets and sets the property ResourceStatus. - - Current status of the resource. - - - - - - Gets and sets the property ResourceStatusReason. - - Success/failure message associated with the resource. - - - - - - Gets and sets the property ResourceType. - - Type of resource. (For more information, go to - AWS Resource Types Reference in the AWS CloudFormation User Guide.) - - - - - - Gets and sets the property StackId. - - The unique ID name of the instance of the stack. - - - - - - Gets and sets the property StackName. - - The name associated with a stack. - - - - - - Gets and sets the property Timestamp. - - Time the status was updated. - - - - - - An AWS CloudFormation stack, in a specific account and Region, that's part of a stack - set operation. A stack instance is a reference to an attempted or actual stack in - a given account within a given Region. A stack instance can exist without a stack—for - example, if the stack couldn't be created for some reason. A stack instance is associated - with only one stack set. Each stack instance contains the ID of its associated stack - set, as well as the ID of the actual stack and the stack status. - - - - - Gets and sets the property Account. - - [Self-managed permissions] The name of the AWS account that the stack instance is - associated with. - - - - - - Gets and sets the property DriftStatus. - - Status of the stack instance's actual configuration compared to the expected template - and parameter configuration of the stack set to which it belongs. - -
  • - - DRIFTED: The stack differs from the expected template and parameter - configuration of the stack set to which it belongs. A stack instance is considered - to have drifted if one or more of the resources in the associated stack have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the stack instance - differs from its expected stack set configuration. - -
  • - - IN_SYNC: The stack instance's actual configuration matches its expected - stack set configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - Gets and sets the property LastDriftCheckTimestamp. - - Most recent time when CloudFormation performed a drift detection operation on the - stack instance. This value will be NULL for any stack instance on which - drift detection has not yet been performed. - - - - - - Gets and sets the property OrganizationalUnitId. - - [Service-managed permissions] The organization root ID or organizational unit (OU) - IDs that you specified for DeploymentTargets. - - - - - - Gets and sets the property ParameterOverrides. - - A list of parameters from the stack set template whose values have been overridden - in this stack instance. - - - - - - Gets and sets the property Region. - - The name of the AWS Region that the stack instance is associated with. - - - - - - Gets and sets the property StackId. - - The ID of the stack instance. - - - - - - Gets and sets the property StackInstanceStatus. - - The detailed status of the stack instance. - - - - - - Gets and sets the property StackSetId. - - The name or unique ID of the stack set that the stack instance is associated with. - - - - - - Gets and sets the property Status. - - The status of the stack instance, in terms of its synchronization with its associated - stack set. - -
  • - - INOPERABLE: A DeleteStackInstances operation has failed - and left the stack in an unstable state. Stacks in this state are excluded from further - UpdateStackSet operations. You might need to perform a DeleteStackInstances - operation, with RetainStacks set to true, to delete the - stack instance, and then delete the stack manually. - -
  • - - OUTDATED: The stack isn't currently up to date with the stack set because: - -
    • - - The associated stack failed during a CreateStackSet or UpdateStackSet - operation. - -
    • - - The stack was part of a CreateStackSet or UpdateStackSet - operation that failed or was stopped before the stack was created or updated. - -
  • - - CURRENT: The stack is currently up to date with the stack set. - -
- - - - - Gets and sets the property StatusReason. - - The explanation for the specific status code that is assigned to this stack instance. - - - - - - The detailed status of the stack instance. - - - - - Gets and sets the property DetailedStatus.
  • - - CANCELLED: The operation in the specified account and Region has been - cancelled. This is either because a user has stopped the stack set operation, or because - the failure tolerance of the stack set operation has been exceeded. - -
  • - - FAILED: The operation in the specified account and Region failed. If - the stack set operation fails in enough accounts within a Region, the failure tolerance - for the stack set operation as a whole might be exceeded. - -
  • - - INOPERABLE: A DeleteStackInstances operation has failed - and left the stack in an unstable state. Stacks in this state are excluded from further - UpdateStackSet operations. You might need to perform a DeleteStackInstances - operation, with RetainStacks set to true, to delete the - stack instance, and then delete the stack manually. - -
  • - - PENDING: The operation in the specified account and Region has yet to - start. - -
  • - - RUNNING: The operation in the specified account and Region is currently - in progress. - -
  • - - SUCCEEDED: The operation in the specified account and Region completed - successfully. - -
- - - - - The status that stack instances are filtered by. - - - - - Gets and sets the property Name. - - The type of filter to apply. - - - - - - Gets and sets the property Values. - - The status to filter by. - - - - - - The specified stack instance doesn't exist. - - - - - Constructs a new StackInstanceNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of StackInstanceNotFoundException - - - - - - - Construct instance of StackInstanceNotFoundException - - - - - - Construct instance of StackInstanceNotFoundException - - - - - - - - - - - Construct instance of StackInstanceNotFoundException - - - - - - - - - - Constructs a new instance of the StackInstanceNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The structure that contains summary information about a stack instance. - - - - - Gets and sets the property Account. - - [Self-managed permissions] The name of the AWS account that the stack instance is - associated with. - - - - - - Gets and sets the property DriftStatus. - - Status of the stack instance's actual configuration compared to the expected template - and parameter configuration of the stack set to which it belongs. - -
  • - - DRIFTED: The stack differs from the expected template and parameter - configuration of the stack set to which it belongs. A stack instance is considered - to have drifted if one or more of the resources in the associated stack have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the stack instance - differs from its expected stack set configuration. - -
  • - - IN_SYNC: The stack instance's actual configuration matches its expected - stack set configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - Gets and sets the property LastDriftCheckTimestamp. - - Most recent time when CloudFormation performed a drift detection operation on the - stack instance. This value will be NULL for any stack instance on which - drift detection has not yet been performed. - - - - - - Gets and sets the property OrganizationalUnitId. - - [Service-managed permissions] The organization root ID or organizational unit (OU) - IDs that you specified for DeploymentTargets. - - - - - - Gets and sets the property Region. - - The name of the AWS Region that the stack instance is associated with. - - - - - - Gets and sets the property StackId. - - The ID of the stack instance. - - - - - - Gets and sets the property StackInstanceStatus. - - The detailed status of the stack instance. - - - - - - Gets and sets the property StackSetId. - - The name or unique ID of the stack set that the stack instance is associated with. - - - - - - Gets and sets the property Status. - - The status of the stack instance, in terms of its synchronization with its associated - stack set. - -
  • - - INOPERABLE: A DeleteStackInstances operation has failed - and left the stack in an unstable state. Stacks in this state are excluded from further - UpdateStackSet operations. You might need to perform a DeleteStackInstances - operation, with RetainStacks set to true, to delete the - stack instance, and then delete the stack manually. - -
  • - - OUTDATED: The stack isn't currently up to date with the stack set because: - -
    • - - The associated stack failed during a CreateStackSet or UpdateStackSet - operation. - -
    • - - The stack was part of a CreateStackSet or UpdateStackSet - operation that failed or was stopped before the stack was created or updated. - -
  • - - CURRENT: The stack is currently up to date with the stack set. - -
- - - - - Gets and sets the property StatusReason. - - The explanation for the specific status code assigned to this stack instance. - - - - - - The StackResource data type. - - - - - Gets and sets the property Description. - - User defined description associated with the resource. - - - - - - Gets and sets the property DriftInformation. - - Information about whether the resource's actual configuration differs, or has drifted, - from its expected configuration, as defined in the stack template and any values specified - as template parameters. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource specified in the template. - - - - - - Gets and sets the property ModuleInfo. - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier that corresponds to a physical instance ID of a resource - supported by AWS CloudFormation. - - - - - - Gets and sets the property ResourceStatus. - - Current status of the resource. - - - - - - Gets and sets the property ResourceStatusReason. - - Success/failure message associated with the resource. - - - - - - Gets and sets the property ResourceType. - - Type of resource. (For more information, go to - AWS Resource Types Reference in the AWS CloudFormation User Guide.) - - - - - - Gets and sets the property StackId. - - Unique identifier of the stack. - - - - - - Gets and sets the property StackName. - - The name associated with the stack. - - - - - - Gets and sets the property Timestamp. - - Time the status was updated. - - - - - - Contains detailed information about the specified stack resource. - - - - - Gets and sets the property Description. - - User defined description associated with the resource. - - - - - - Gets and sets the property DriftInformation. - - Information about whether the resource's actual configuration differs, or has drifted, - from its expected configuration, as defined in the stack template and any values specified - as template parameters. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - - Gets and sets the property LastUpdatedTimestamp. - - Time the status was updated. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource specified in the template. - - - - - - Gets and sets the property Metadata. - - The content of the Metadata attribute declared for the resource. For - more information, see Metadata - Attribute in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property ModuleInfo. - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier that corresponds to a physical instance ID of a resource - supported by AWS CloudFormation. - - - - - - Gets and sets the property ResourceStatus. - - Current status of the resource. - - - - - - Gets and sets the property ResourceStatusReason. - - Success/failure message associated with the resource. - - - - - - Gets and sets the property ResourceType. - - Type of resource. ((For more information, go to - AWS Resource Types Reference in the AWS CloudFormation User Guide.) - - - - - - Gets and sets the property StackId. - - Unique identifier of the stack. - - - - - - Gets and sets the property StackName. - - The name associated with the stack. - - - - - - Contains the drift information for a resource that has been checked for drift. This - includes actual and expected property values for resources in which AWS CloudFormation - has detected drift. Only resource properties explicitly defined in the stack template - are checked for drift. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all resources in a given stack that support drift detection. - - - - - - Gets and sets the property ActualProperties. - - A JSON structure containing the actual property values of the stack resource. - - - - For resources whose StackResourceDriftStatus is DELETED, - this structure will not be present. - - - - - - Gets and sets the property ExpectedProperties. - - A JSON structure containing the expected property values of the stack resource, as - defined in the stack template and any values specified as template parameters. - - - - For resources whose StackResourceDriftStatus is DELETED, - this structure will not be present. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource specified in the template. - - - - - - Gets and sets the property ModuleInfo. - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier that corresponds to a physical instance ID of a resource - supported by AWS CloudFormation. - - - - - - Gets and sets the property PhysicalResourceIdContext. - - Context information that enables AWS CloudFormation to uniquely identify a resource. - AWS CloudFormation uses context key-value pairs in cases where a resource's logical - and physical IDs are not enough to uniquely identify that resource. Each context key-value - pair specifies a unique resource that contains the targeted resource. - - - - - - Gets and sets the property PropertyDifferences. - - A collection of the resource properties whose actual values differ from their expected - values. These will be present only for resources whose StackResourceDriftStatus - is MODIFIED. - - - - - - Gets and sets the property ResourceType. - - The type of the resource. - - - - - - Gets and sets the property StackId. - - The ID of the stack. - - - - - - Gets and sets the property StackResourceDriftStatus. - - Status of the resource's actual configuration compared to its expected configuration - -
  • - - DELETED: The resource differs from its expected template configuration - because the resource has been deleted. - -
  • - - MODIFIED: One or more resource properties differ from their expected - values (as defined in the stack template and any values specified as template parameters). - -
  • - - IN_SYNC: The resources's actual configuration matches its expected template - configuration. - -
  • - - NOT_CHECKED: AWS CloudFormation does not currently return this value. - -
- - - - - Gets and sets the property Timestamp. - - Time at which AWS CloudFormation performed drift detection on the stack resource. - - - - - - Contains information about whether the resource's actual configuration differs, or - has drifted, from its expected configuration. - - - - - Gets and sets the property LastCheckTimestamp. - - When AWS CloudFormation last checked if the resource had drifted from its expected - configuration. - - - - - - Gets and sets the property StackResourceDriftStatus. - - Status of the resource's actual configuration compared to its expected configuration - -
  • - - DELETED: The resource differs from its expected configuration in that - it has been deleted. - -
  • - - MODIFIED: The resource differs from its expected configuration. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the resource differs - from its expected configuration. - - - - Any resources that do not currently support drift detection have a status of NOT_CHECKED. - For more information, see Resources - that Support Drift Detection. - -
  • - - IN_SYNC: The resources's actual configuration matches its expected configuration. - -
- - - - - Summarizes information about whether the resource's actual configuration differs, - or has drifted, from its expected configuration. - - - - - Gets and sets the property LastCheckTimestamp. - - When AWS CloudFormation last checked if the resource had drifted from its expected - configuration. - - - - - - Gets and sets the property StackResourceDriftStatus. - - Status of the resource's actual configuration compared to its expected configuration - -
  • - - DELETED: The resource differs from its expected configuration in that - it has been deleted. - -
  • - - MODIFIED: The resource differs from its expected configuration. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked if the resource differs - from its expected configuration. - - - - Any resources that do not currently support drift detection have a status of NOT_CHECKED. - For more information, see Resources - that Support Drift Detection. If you performed an ContinueUpdateRollback - operation on a stack, any resources included in ResourcesToSkip will - also have a status of NOT_CHECKED. For more information on skipping resources - during rollback operations, see Continue - Rolling Back an Update in the AWS CloudFormation User Guide. - -
  • - - IN_SYNC: The resources's actual configuration matches its expected configuration. - -
- - - - - Contains high-level information about the specified stack resource. - - - - - Gets and sets the property DriftInformation. - - Information about whether the resource's actual configuration differs, or has drifted, - from its expected configuration, as defined in the stack template and any values specified - as template parameters. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - - Gets and sets the property LastUpdatedTimestamp. - - Time the status was updated. - - - - - - Gets and sets the property LogicalResourceId. - - The logical name of the resource specified in the template. - - - - - - Gets and sets the property ModuleInfo. - - Contains information about the module from which the resource was created, if the - resource was created from a module included in the stack template. - - - - - - Gets and sets the property PhysicalResourceId. - - The name or unique identifier that corresponds to a physical instance ID of the resource. - - - - - - Gets and sets the property ResourceStatus. - - Current status of the resource. - - - - - - Gets and sets the property ResourceStatusReason. - - Success/failure message associated with the resource. - - - - - - Gets and sets the property ResourceType. - - Type of resource. (For more information, go to - AWS Resource Types Reference in the AWS CloudFormation User Guide.) - - - - - - A structure that contains information about a stack set. A stack set enables you to - provision stacks into AWS accounts and across Regions by using a single CloudFormation - template. In the stack set, you specify the template to use, as well as any parameters - and capabilities that the template requires. - - - - - Gets and sets the property AdministrationRoleARN. - - The Amazon Resource Number (ARN) of the IAM role used to create or update the stack - set. - - - - Use customized administrator roles to control which users or groups can manage specific - stack sets within the same administrator account. For more information, see Prerequisites: - Granting Permissions for Stack Set Operations in the AWS CloudFormation User - Guide. - - - - - - Gets and sets the property AutoDeployment. - - [Service-managed permissions] Describes whether StackSets automatically deploys to - AWS Organizations accounts that are added to a target organization or organizational - unit (OU). - - - - - - Gets and sets the property Capabilities. - - The capabilities that are allowed in the stack set. Some stack set templates might - include resources that can affect permissions in your AWS account—for example, by - creating new AWS Identity and Access Management (IAM) users. For more information, - see Acknowledging - IAM Resources in AWS CloudFormation Templates. - - - - - - Gets and sets the property Description. - - A description of the stack set that you specify when the stack set is created or updated. - - - - - - Gets and sets the property ExecutionRoleName. - - The name of the IAM execution role used to create or update the stack set. - - - - Use customized execution roles to control which stack resources users and groups can - include in their stack sets. - - - - - - Gets and sets the property OrganizationalUnitIds. - - [Service-managed permissions] The organization root ID or organizational unit (OU) - IDs that you specified for DeploymentTargets. - - - - - - Gets and sets the property Parameters. - - A list of input parameters for a stack set. - - - - - - Gets and sets the property PermissionModel. - - Describes how the IAM roles required for stack set operations are created. - - - - - - - Gets and sets the property StackSetARN. - - The Amazon Resource Number (ARN) of the stack set. - - - - - - Gets and sets the property StackSetDriftDetectionDetails. - - Detailed information about the drift status of the stack set. - - - - For stack sets, contains information about the last completed drift operation - performed on the stack set. Information about drift operations currently in progress - is not included. - - - - - - Gets and sets the property StackSetId. - - The ID of the stack set. - - - - - - Gets and sets the property StackSetName. - - The name that's associated with the stack set. - - - - - - Gets and sets the property Status. - - The status of the stack set. - - - - - - Gets and sets the property Tags. - - A list of tags that specify information about the stack set. A maximum number of 50 - tags can be specified. - - - - - - Gets and sets the property TemplateBody. - - The structure that contains the body of the template that was used to create or update - the stack set. - - - - - - Detailed information about the drift status of the stack set. - - - - For stack sets, contains information about the last completed drift operation - performed on the stack set. Information about drift operations in-progress is not - included. - - - - For stack set operations, includes information about drift operations currently being - performed on the stack set. - - - - For more information, see Detecting - Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property DriftDetectionStatus. - - The status of the stack set drift detection operation. - -
  • - - COMPLETED: The drift detection operation completed without failing on - any stack instances. - -
  • - - FAILED: The drift detection operation exceeded the specified failure - tolerance. - -
  • - - PARTIAL_SUCCESS: The drift detection operation completed without exceeding - the failure tolerance for the operation. - -
  • - - IN_PROGRESS: The drift detection operation is currently being performed. - -
  • - - STOPPED: The user has cancelled the drift detection operation. - -
- - - - - Gets and sets the property DriftedStackInstancesCount. - - The number of stack instances that have drifted from the expected template and parameter - configuration of the stack set. A stack instance is considered to have drifted if - one or more of the resources in the associated stack do not match their expected configuration. - - - - - - Gets and sets the property DriftStatus. - - Status of the stack set's actual configuration compared to its expected template and - parameter configuration. A stack set is considered to have drifted if one or more - of its stack instances have drifted from their expected template and parameter configuration. - -
  • - - DRIFTED: One or more of the stack instances belonging to the stack set - stack differs from the expected template and parameter configuration. A stack instance - is considered to have drifted if one or more of the resources in the associated stack - have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. - -
  • - - IN_SYNC: All of the stack instances belonging to the stack set stack - match from the expected template and parameter configuration. - -
- - - - - Gets and sets the property FailedStackInstancesCount. - - The number of stack instances for which the drift detection operation failed. - - - - - - Gets and sets the property InProgressStackInstancesCount. - - The number of stack instances that are currently being checked for drift. - - - - - - Gets and sets the property InSyncStackInstancesCount. - - The number of stack instances which match the expected template and parameter configuration - of the stack set. - - - - - - Gets and sets the property LastDriftCheckTimestamp. - - Most recent time when CloudFormation performed a drift detection operation on the - stack set. This value will be NULL for any stack set on which drift detection - has not yet been performed. - - - - - - Gets and sets the property TotalStackInstancesCount. - - The total number of stack instances belonging to this stack set. - - - - The total number of stack instances is equal to the total of: - -
  • - - Stack instances that match the stack set configuration. - -
  • - - Stack instances that have drifted from the stack set configuration. - -
  • - - Stack instances where the drift detection operation has failed. - -
  • - - Stack instances currently being checked for drift. - -
- - - - - You can't yet delete this stack set, because it still contains one or more stack instances. - Delete all stack instances from the stack set before deleting the stack set. - - - - - Constructs a new StackSetNotEmptyException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of StackSetNotEmptyException - - - - - - - Construct instance of StackSetNotEmptyException - - - - - - Construct instance of StackSetNotEmptyException - - - - - - - - - - - Construct instance of StackSetNotEmptyException - - - - - - - - - - Constructs a new instance of the StackSetNotEmptyException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The specified stack set doesn't exist. - - - - - Constructs a new StackSetNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of StackSetNotFoundException - - - - - - - Construct instance of StackSetNotFoundException - - - - - - Construct instance of StackSetNotFoundException - - - - - - - - - - - Construct instance of StackSetNotFoundException - - - - - - - - - - Constructs a new instance of the StackSetNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The structure that contains information about a stack set operation. - - - - - Gets and sets the property Action. - - The type of stack set operation: CREATE, UPDATE, or DELETE. - Create and delete operations affect only the specified stack set instances that are - associated with the specified stack set. Update operations affect both the stack set - itself, as well as all associated stack set instances. - - - - - - Gets and sets the property AdministrationRoleARN. - - The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. - - - - - Use customized administrator roles to control which users or groups can manage specific - stack sets within the same administrator account. For more information, see Define - Permissions for Multiple Administrators in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property CreationTimestamp. - - The time at which the operation was initiated. Note that the creation times for the - stack set operation might differ from the creation time of the individual stacks themselves. - This is because AWS CloudFormation needs to perform preparatory work for the operation, - such as dispatching the work to the requested Regions, before actually creating the - first stacks. - - - - - - Gets and sets the property DeploymentTargets. - - [Service-managed permissions] The AWS Organizations accounts affected by the stack - operation. - - - - - - Gets and sets the property EndTimestamp. - - The time at which the stack set operation ended, across all accounts and Regions specified. - Note that this doesn't necessarily mean that the stack set operation was successful, - or even attempted, in each account or Region. - - - - - - Gets and sets the property ExecutionRoleName. - - The name of the IAM execution role used to create or update the stack set. - - - - Use customized execution roles to control which stack resources users and groups can - include in their stack sets. - - - - - - Gets and sets the property OperationId. - - The unique ID of a stack set operation. - - - - - - Gets and sets the property OperationPreferences. - - The preferences for how AWS CloudFormation performs this stack set operation. - - - - - - Gets and sets the property RetainStacks. - - For stack set operations of action type DELETE, specifies whether to - remove the stack instances from the specified stack set, but doesn't delete the stacks. - You can't reassociate a retained stack, or add an existing, saved stack to a new stack - set. - - - - - - Gets and sets the property StackSetDriftDetectionDetails. - - Detailed information about the drift status of the stack set. This includes information - about drift operations currently being performed on the stack set. - - - - this information will only be present for stack set operations whose Action - type is DETECT_DRIFT. - - - - For more information, see Detecting - Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property StackSetId. - - The ID of the stack set. - - - - - - Gets and sets the property Status. - - The status of the operation. - -
  • - - FAILED: The operation exceeded the specified failure tolerance. The - failure tolerance value that you've set for an operation is applied for each Region - during stack create and update operations. If the number of failed stacks within a - Region exceeds the failure tolerance, the status of the operation in the Region is - set to FAILED. This in turn sets the status of the operation as a whole - to FAILED, and AWS CloudFormation cancels the operation in any remaining - Regions. - -
  • - - QUEUED: [Service-managed permissions] For automatic deployments that - require a sequence of operations, the operation is queued to be performed. For more - information, see the stack - set operation status codes in the AWS CloudFormation User Guide. - -
  • - - RUNNING: The operation is currently being performed. - -
  • - - STOPPED: The user has cancelled the operation. - -
  • - - STOPPING: The operation is in the process of stopping, at user request. - - -
  • - - SUCCEEDED: The operation completed creating or updating all the specified - stacks without exceeding the failure tolerance for the operation. - -
- - - - - The user-specified preferences for how AWS CloudFormation performs a stack set operation. - - - - - For more information on maximum concurrent accounts and failure tolerance, see Stack - set operation options. - - - - - - Gets and sets the property FailureToleranceCount. - - The number of accounts, per Region, for which this operation can fail before AWS CloudFormation - stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation - doesn't attempt the operation in any subsequent Regions. - - - - Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage - (but not both). - - - - By default, 0 is specified. - - - - - - Gets and sets the property FailureTolerancePercentage. - - The percentage of accounts, per Region, for which this stack operation can fail before - AWS CloudFormation stops the operation in that Region. If the operation is stopped - in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions. - - - - When calculating the number of accounts based on the specified percentage, AWS CloudFormation - rounds down to the next whole number. - - - - Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, - but not both. - - - - By default, 0 is specified. - - - - - - Gets and sets the property MaxConcurrentCount. - - The maximum number of accounts in which to perform this operation at one time. This - is dependent on the value of FailureToleranceCount. MaxConcurrentCount - is at most one more than the FailureToleranceCount. - - - - Note that this setting lets you specify the maximum for operations. For large - deployments, under certain circumstances the actual number of accounts acted upon - concurrently may be lower due to service throttling. - - - - Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, - but not both. - - - - By default, 1 is specified. - - - - - - Gets and sets the property MaxConcurrentPercentage. - - The maximum percentage of accounts in which to perform this operation at one time. - - - - When calculating the number of accounts based on the specified percentage, AWS CloudFormation - rounds down to the next whole number. This is true except in cases where rounding - down would result is zero. In this case, CloudFormation sets the number as one instead. - - - - Note that this setting lets you specify the maximum for operations. For large - deployments, under certain circumstances the actual number of accounts acted upon - concurrently may be lower due to service throttling. - - - - Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, - but not both. - - - - By default, 1 is specified. - - - - - - Gets and sets the property RegionConcurrencyType. - - The concurrency type of deploying StackSets operations in regions, could be in parallel - or one region at a time. - - - - - - Gets and sets the property RegionOrder. - - The order of the Regions in where you want to perform the stack operation. - - - - - - The structure that contains information about a specified operation's results for - a given account in a given Region. - - - - - Gets and sets the property Account. - - [Self-managed permissions] The name of the AWS account for this operation result. - - - - - - Gets and sets the property AccountGateResult. - - The results of the account gate function AWS CloudFormation invokes, if present, before - proceeding with stack set operations in an account - - - - - - Gets and sets the property OrganizationalUnitId. - - [Service-managed permissions] The organization root ID or organizational unit (OU) - IDs that you specified for DeploymentTargets. - - - - - - Gets and sets the property Region. - - The name of the AWS Region for this operation result. - - - - - - Gets and sets the property Status. - - The result status of the stack set operation for the given account in the given Region. - -
  • - - CANCELLED: The operation in the specified account and Region has been - cancelled. This is either because a user has stopped the stack set operation, or because - the failure tolerance of the stack set operation has been exceeded. - -
  • - - FAILED: The operation in the specified account and Region failed. - - - - If the stack set operation fails in enough accounts within a Region, the failure tolerance - for the stack set operation as a whole might be exceeded. - -
  • - - RUNNING: The operation in the specified account and Region is currently - in progress. - -
  • - - PENDING: The operation in the specified account and Region has yet to - start. - -
  • - - SUCCEEDED: The operation in the specified account and Region completed - successfully. - -
- - - - - Gets and sets the property StatusReason. - - The reason for the assigned result status. - - - - - - The structures that contain summary information about the specified operation. - - - - - Gets and sets the property Action. - - The type of operation: CREATE, UPDATE, or DELETE. - Create and delete operations affect only the specified stack instances that are associated - with the specified stack set. Update operations affect both the stack set itself as - well as all associated stack set instances. - - - - - - Gets and sets the property CreationTimestamp. - - The time at which the operation was initiated. Note that the creation times for the - stack set operation might differ from the creation time of the individual stacks themselves. - This is because AWS CloudFormation needs to perform preparatory work for the operation, - such as dispatching the work to the requested Regions, before actually creating the - first stacks. - - - - - - Gets and sets the property EndTimestamp. - - The time at which the stack set operation ended, across all accounts and Regions specified. - Note that this doesn't necessarily mean that the stack set operation was successful, - or even attempted, in each account or Region. - - - - - - Gets and sets the property OperationId. - - The unique ID of the stack set operation. - - - - - - Gets and sets the property Status. - - The overall status of the operation. - -
  • - - FAILED: The operation exceeded the specified failure tolerance. The - failure tolerance value that you've set for an operation is applied for each Region - during stack create and update operations. If the number of failed stacks within a - Region exceeds the failure tolerance, the status of the operation in the Region is - set to FAILED. This in turn sets the status of the operation as a whole - to FAILED, and AWS CloudFormation cancels the operation in any remaining - Regions. - -
  • - - QUEUED: [Service-managed permissions] For automatic deployments that - require a sequence of operations, the operation is queued to be performed. For more - information, see the stack - set operation status codes in the AWS CloudFormation User Guide. - -
  • - - RUNNING: The operation is currently being performed. - -
  • - - STOPPED: The user has cancelled the operation. - -
  • - - STOPPING: The operation is in the process of stopping, at user request. - - -
  • - - SUCCEEDED: The operation completed creating or updating all the specified - stacks without exceeding the failure tolerance for the operation. - -
- - - - - The structures that contain summary information about the specified stack set. - - - - - Gets and sets the property AutoDeployment. - - [Service-managed permissions] Describes whether StackSets automatically deploys to - AWS Organizations accounts that are added to a target organizational unit (OU). - - - - - - Gets and sets the property Description. - - A description of the stack set that you specify when the stack set is created or updated. - - - - - - Gets and sets the property DriftStatus. - - Status of the stack set's actual configuration compared to its expected template and - parameter configuration. A stack set is considered to have drifted if one or more - of its stack instances have drifted from their expected template and parameter configuration. - -
  • - - DRIFTED: One or more of the stack instances belonging to the stack set - stack differs from the expected template and parameter configuration. A stack instance - is considered to have drifted if one or more of the resources in the associated stack - have drifted. - -
  • - - NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. - -
  • - - IN_SYNC: All of the stack instances belonging to the stack set stack - match from the expected template and parameter configuration. - -
  • - - UNKNOWN: This value is reserved for future use. - -
- - - - - Gets and sets the property LastDriftCheckTimestamp. - - Most recent time when CloudFormation performed a drift detection operation on the - stack set. This value will be NULL for any stack set on which drift detection - has not yet been performed. - - - - - - Gets and sets the property PermissionModel. - - Describes how the IAM roles required for stack set operations are created. - - - - - - - Gets and sets the property StackSetId. - - The ID of the stack set. - - - - - - Gets and sets the property StackSetName. - - The name of the stack set. - - - - - - Gets and sets the property Status. - - The status of the stack set. - - - - - - The StackSummary Data Type - - - - - Gets and sets the property CreationTime. - - The time the stack was created. - - - - - - Gets and sets the property DeletionTime. - - The time the stack was deleted. - - - - - - Gets and sets the property DriftInformation. - - Summarizes information on whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. For more information, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - - - Gets and sets the property LastUpdatedTime. - - The time the stack was last updated. This field will only be returned if the stack - has been updated at least once. - - - - - - Gets and sets the property ParentId. - - For nested stacks--stacks created as resources for another stack--the stack ID of - the direct parent of this stack. For the first level of nested stacks, the root stack - is also the parent stack. - - - - For more information, see Working - with Nested Stacks in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property RootId. - - For nested stacks--stacks created as resources for another stack--the stack ID of - the top-level stack to which the nested stack ultimately belongs. - - - - For more information, see Working - with Nested Stacks in the AWS CloudFormation User Guide. - - - - - - Gets and sets the property StackId. - - Unique stack identifier. - - - - - - Gets and sets the property StackName. - - The name associated with the stack. - - - - - - Gets and sets the property StackStatus. - - The current status of the stack. - - - - - - Gets and sets the property StackStatusReason. - - Success/Failure message associated with the stack status. - - - - - - Gets and sets the property TemplateDescription. - - The template description of the template used to create the stack. - - - - - - Another operation has been performed on this stack set since the specified operation - was performed. - - - - - Constructs a new StaleRequestException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of StaleRequestException - - - - - - - Construct instance of StaleRequestException - - - - - - Construct instance of StaleRequestException - - - - - - - - - - - Construct instance of StaleRequestException - - - - - - - - - - Constructs a new instance of the StaleRequestException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the StopStackSetOperation operation. - Stops an in-progress operation on a stack set and its associated stack instances. - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property OperationId. - - The ID of the stack operation. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to stop the operation for. - - - - - - This is the response object from the StopStackSetOperation operation. - - - - - The Tag type enables you to specify a key-value pair that can be used to store information - about an AWS CloudFormation stack. - - - - - Gets and sets the property Key. - - Required. A string used to identify this tag. You can specify a maximum of - 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved - prefix: aws:. - - - - - - Gets and sets the property Value. - - Required. A string containing the value for this tag. You can specify a maximum - of 256 characters for a tag value. - - - - - - The TemplateParameter data type. - - - - - Gets and sets the property DefaultValue. - - The default value associated with the parameter. - - - - - - Gets and sets the property Description. - - User defined description associated with the parameter. - - - - - - Gets and sets the property NoEcho. - - Flag indicating whether the parameter should be displayed as plain text in logs and - UIs. - - - - - - Gets and sets the property ParameterKey. - - The name associated with the parameter. - - - - - - Container for the parameters to the TestType operation. - Tests a registered extension to make sure it meets all necessary requirements for - being published in the CloudFormation registry. - -
  • - - For resource types, this includes passing all contracts tests defined for the type. - -
  • - - For modules, this includes determining if the module's model meets all necessary requirements. - -
- - For more information, see Testing - your public extension prior to publishing in the CloudFormation CLI User Guide. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in your account and region for testing. - - - - To perform testing, CloudFormation assumes the execution role specified when the test - was registered. For more information, see RegisterType. - - - - Once you've initiated testing on an extension using TestType, you can - use DescribeType - to monitor the current test status and test status description for the extension. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Number (ARN) of the extension. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - Gets and sets the property LogDeliveryBucket. - - The S3 bucket to which CloudFormation delivers the contract test execution logs. - - - - CloudFormation delivers the logs by the time contract testing has completed and the - extension has been assigned a test type status of PASSED or FAILED. - - - - The user calling TestType must be able to access items in the specified - S3 bucket. Specifically, the user needs the following permissions: - -
  • - - GetObject - -
  • - - PutObject - -
- - For more information, see Actions, - Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access - Management User Guide. - - - - - - Gets and sets the property Type. - - The type of the extension to test. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - Gets and sets the property TypeName. - - The name of the extension to test. - - - - Conditional: You must specify Arn, or TypeName and Type. - - - - - - Gets and sets the property VersionId. - - The version of the extension to test. - - - - You can specify the version id with either Arn, or with TypeName - and Type. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in this account and region for testing. - - - - - - This is the response object from the TestType operation. - - - - - Gets and sets the property TypeVersionArn. - - The Amazon Resource Number (ARN) of the extension. - - - - - - A client request token already exists. - - - - - Constructs a new TokenAlreadyExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TokenAlreadyExistsException - - - - - - - Construct instance of TokenAlreadyExistsException - - - - - - Construct instance of TokenAlreadyExistsException - - - - - - - - - - - Construct instance of TokenAlreadyExistsException - - - - - - - - - - Constructs a new instance of the TokenAlreadyExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Detailed information concerning the specification of a CloudFormation extension in - a given account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - - - Gets and sets the property Alias. - - The alias specified for this configuration, if one was specified when the configuration - was set. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) for the configuration data, in this account and region. - - - - - - Gets and sets the property Configuration. - - A JSON string specifying the configuration data for the extension, in this account - and region. - - - - If a configuration has not been set for a specified extension, CloudFormation returns - {}. - - - - - - Gets and sets the property IsDefaultConfiguration. - - Whether or not this configuration data is the default configuration for the extension. - - - - - - Gets and sets the property LastUpdated. - - When the configuration data was last updated for this extension. - - - - If a configuration has not been set for a specified extension, CloudFormation returns - null. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) for the extension, in this account and region. - - - - For public extensions, this will be the ARN assigned when you activate - the type in this account and region. For private extensions, this will be the - ARN assigned when you register - the type in this account and region. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - - - Identifying information for the configuration of a CloudFormation extension. - - - - - Gets and sets the property Type. - - The type of extension. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) for the extension, in this account and region. - - - - For public extensions, this will be the ARN assigned when you activate - the type in this account and region. For private extensions, this will be the - ARN assigned when you register - the type in this account and region. - - - - - - Gets and sets the property TypeConfigurationAlias. - - The alias specified for this configuration, if one was specified when the configuration - was set. - - - - - - Gets and sets the property TypeConfigurationArn. - - The Amazon Resource Name (ARN) for the configuration, in this account and region. - - - - - - Gets and sets the property TypeName. - - The name of the extension type to which this configuration applies. - - - - - - The specified extension configuration cannot be found. - - - - - Constructs a new TypeConfigurationNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TypeConfigurationNotFoundException - - - - - - - Construct instance of TypeConfigurationNotFoundException - - - - - - Construct instance of TypeConfigurationNotFoundException - - - - - - - - - - - Construct instance of TypeConfigurationNotFoundException - - - - - - - - - - Constructs a new instance of the TypeConfigurationNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Filter criteria to use in determining which extensions to return. - - - - - Gets and sets the property Category. - - The category of extensions to return. - -
  • - - REGISTERED: Private extensions that have been registered for this account - and region. - -
  • - - ACTIVATED: Public extensions that have been activated for this account - and region. - -
  • - - THIRD-PARTY: Extensions available for use from publishers other than - Amazon. This includes: - -
    • - - Private extensions registered in the account. - -
    • - - Public extensions from publishers other than Amazon, whether activated or not. - -
  • - - AWS-TYPES: Extensions available for use from Amazon. - -
- - - - - Gets and sets the property PublisherId. - - The id of the publisher of the extension. - - - - Extensions published by Amazon are not assigned a publisher ID. Use the AWS-TYPES - category to specify a list of types published by Amazon. - - - - - - Gets and sets the property TypeNamePrefix. - - A prefix to use as a filter for results. - - - - - - The specified extension does not exist in the CloudFormation registry. - - - - - Constructs a new TypeNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TypeNotFoundException - - - - - - - Construct instance of TypeNotFoundException - - - - - - Construct instance of TypeNotFoundException - - - - - - - - - - - Construct instance of TypeNotFoundException - - - - - - - - - - Constructs a new instance of the TypeNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Contains summary information about the specified CloudFormation extension. - - - - - Gets and sets the property DefaultVersionId. - - The ID of the default version of the extension. The default version is used when the - extension version is not specified. - - - - This applies only to private extensions you have registered in your account. For public - extensions, both those provided by Amazon and published by third parties, CloudFormation - returns null. For more information, see RegisterType. - - - - To set the default version of an extension, use SetTypeDefaultVersion - . - - - - - - Gets and sets the property Description. - - The description of the extension. - - - - - - Gets and sets the property IsActivated. - - Whether or not the extension is activated for this account and region. - - - - This applies only to third-party public extensions. Extensions published by Amazon - are activated by default. - - - - - - Gets and sets the property LastUpdated. - - When the specified extension version was registered. This applies only to: - -
  • - - Private extensions you have registered in your account. For more information, see - RegisterType. - -
  • - - Public extensions you have activated in your account with auto-update specified. For - more information, see ActivateType. - -
- - For all other extension types, CloudFormation returns null. - - - - - - Gets and sets the property LatestPublicVersion. - - For public extensions that have been activated for this account and region, the latest - version of the public extension that is available. For any extensions other - than activated third-arty extensions, CloudFormation returns null. - - - - How you specified AutoUpdate when enabling the extension affects whether - CloudFormation automatically updates the extention in this account and region when - a new version is released. For more information, see Setting - CloudFormation to automatically use new versions of extensions in the CloudFormation - User Guide. - - - - - - Gets and sets the property OriginalTypeName. - - For public extensions that have been activated for this account and region, the type - name of the public extension. - - - - If you specified a TypeNameAlias when enabling the extension in this - account and region, CloudFormation treats that alias as the extension's type name - within the account and region, not the type name of the public extension. For more - information, see Specifying - aliases to refer to extensions in the CloudFormation User Guide. - - - - - - Gets and sets the property PublicVersionNumber. - - For public extensions that have been activated for this account and region, the version - of the public extension to be used for CloudFormation operations in this account and - region. - - - - How you specified AutoUpdate when enabling the extension affects whether - CloudFormation automatically updates the extention in this account and region when - a new version is released. For more information, see Setting - CloudFormation to automatically use new versions of extensions in the CloudFormation - User Guide. - - - - - - Gets and sets the property PublisherId. - - The ID of the extension publisher, if the extension is published by a third party. - Extensions published by Amazon do not return a publisher ID. - - - - - - Gets and sets the property PublisherIdentity. - - The service used to verify the publisher identity. - - - - For more information, see Registering - your account to publish CloudFormation extensions in the CFN-CLI User Guide - for Extension Development. - - - - - - Gets and sets the property PublisherName. - - The publisher name, as defined in the public profile for that publisher in the service - used to verify the publisher identity. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - - - Gets and sets the property TypeArn. - - The Amazon Resource Name (ARN) of the extension. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - If you specified a TypeNameAlias when you activate - this extension in your account and region, CloudFormation considers that alias - as the type name. - - - - - - Contains summary information about a specific version of a CloudFormation extension. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the extension version. - - - - - - Gets and sets the property Description. - - The description of the extension version. - - - - - - Gets and sets the property IsDefaultVersion. - - Whether the specified extension version is set as the default version. - - - - This applies only to private extensions you have registered in your account, and extensions - published by Amazon. For public third-party extensions, whether or not they are activated - in your account, CloudFormation returns null. - - - - - - Gets and sets the property PublicVersionNumber. - - For public extensions that have been activated for this account and region, the version - of the public extension to be used for CloudFormation operations in this account and - region. For any extensions other than activated third-arty extensions, CloudFormation - returns null. - - - - How you specified AutoUpdate when enabling the extension affects whether - CloudFormation automatically updates the extention in this account and region when - a new version is released. For more information, see Setting - CloudFormation to automatically use new versions of extensions in the CloudFormation - User Guide. - - - - - - Gets and sets the property TimeCreated. - - When the version was registered. - - - - - - Gets and sets the property Type. - - The kind of extension. - - - - - - Gets and sets the property TypeName. - - The name of the extension. - - - - - - Gets and sets the property VersionId. - - The ID of a specific version of the extension. The version ID is the value at the - end of the Amazon Resource Name (ARN) assigned to the extension version when it is - registered. - - - - - - Container for the parameters to the UpdateStackInstances operation. - Updates the parameter values for stack instances for the specified accounts, within - the specified Regions. A stack instance refers to a stack in a specific account and - Region. - - - - You can only update stack instances in Regions and accounts where they already exist; - to create additional stack instances, use CreateStackInstances. - - - - - During stack set updates, any parameters overridden for a stack instance are not updated, - but retain their overridden value. - - - - You can only update the parameter values that are specified in the stack set; - to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. If you add a parameter to a template, before you - can override the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - - - - Gets and sets the property Accounts. - - [Self-managed permissions] The names of one or more AWS accounts for which you want - to update parameter values for stack instances. The overridden parameter values will - be applied to all stack instances in the specified accounts and Regions. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property DeploymentTargets. - - [Service-managed permissions] The AWS Organizations accounts for which you want to - update parameter values for stack instances. If your update targets OUs, the overridden - parameter values only apply to the accounts that are currently in the target OUs and - their child OUs. Accounts added to the target OUs and their child OUs in the future - won't use the overridden values. - - - - You can specify Accounts or DeploymentTargets, but not both. - - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation - performs the stack set operation only once, even if you retry the request multiple - times. You might retry stack set operation requests to ensure that AWS CloudFormation - successfully received them. - - - - If you don't specify an operation ID, the SDK generates one automatically. - - - - - - Gets and sets the property OperationPreferences. - - Preferences for how AWS CloudFormation performs this stack set operation. - - - - - - Gets and sets the property ParameterOverrides. - - A list of input parameters whose values you want to update for the specified stack - instances. - - - - Any overridden parameter values will be applied to all stack instances in the specified - accounts and Regions. When specifying parameters and their values, be aware of how - AWS CloudFormation sets parameter values during stack instance update operations: - -
  • - - To override the current value for a parameter, include the parameter and specify its - value. - -
  • - - To leave a parameter set to its present value, you can do one of the following: - -
    • - - Do not include the parameter in the list. - -
    • - - Include the parameter and specify UsePreviousValue as true. - (You cannot specify both a value and set UsePreviousValue to true.) - -
  • - - To set all overridden parameter back to the values specified in the stack set, specify - a parameter list but do not include any parameters. - -
  • - - To leave all parameters set to their present values, do not specify this property - at all. - -
- - During stack set updates, any parameter values overridden for a stack instance are - not updated, but retain their overridden value. - - - - You can only override the parameter values that are specified in the stack - set; to add or delete a parameter itself, use UpdateStackSet to update - the stack set template. If you add a parameter to a template, before you can override - the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - - - - Gets and sets the property Regions. - - The names of one or more Regions in which you want to update parameter values for - stack instances. The overridden parameter values will be applied to all stack instances - in the specified accounts and Regions. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set associated with the stack instances. - - - - - - This is the response object from the UpdateStackInstances operation. - - - - - Gets and sets the property OperationId. - - The unique identifier for this stack set operation. - - - - - - The output for an UpdateStack action. - - - - - Gets and sets the property StackId. - - Unique identifier of the stack. - - - - - - Container for the parameters to the UpdateStackSet operation. - Updates the stack set, and associated stack instances in the specified accounts and - Regions. - - - - Even if the stack set operation created by updating the stack set fails (completely - or partially, below or above a specified failure tolerance), the stack set is updated - with your changes. Subsequent CreateStackInstances calls on the specified stack - set use the updated stack set. - - - - - - Gets and sets the property Accounts. - - [Self-managed permissions] The accounts in which to update associated stack instances. - If you specify accounts, you must also specify the Regions in which to update stack - set instances. - - - - To update all the stack instances associated with this stack set, do not specify - the Accounts or Regions properties. - - - - If the stack set update includes changes to the template (that is, if the TemplateBody - or TemplateURL properties are specified), or the Parameters - property, AWS CloudFormation marks all stack instances with a status of OUTDATED - prior to updating the stack instances in the specified accounts and Regions. If the - stack set update does not include changes to the template or parameters, AWS CloudFormation - updates the stack instances in the specified accounts and Regions, while leaving all - other stack instances with their existing stack instance status. - - - - - - Gets and sets the property AdministrationRoleARN. - - The Amazon Resource Number (ARN) of the IAM role to use to update this stack set. - - - - Specify an IAM role only if you are using customized administrator roles to control - which users or groups can manage specific stack sets within the same administrator - account. For more information, see Granting - Permissions for Stack Set Operations in the AWS CloudFormation User Guide. - - - - If you specified a customized administrator role when you created the stack set, you - must specify a customized administrator role, even if it is the same customized administrator - role used with this stack set previously. - - - - - - Gets and sets the property AutoDeployment. - - [Service-managed permissions] Describes whether StackSets automatically deploys to - AWS Organizations accounts that are added to a target organization or organizational - unit (OU). - - - - If you specify AutoDeployment, do not specify DeploymentTargets - or Regions. - - - - - - Gets and sets the property CallAs. - - [Service-managed permissions] Specifies whether you are acting as an account administrator - in the organization's management account or as a delegated administrator in a member - account. - - - - By default, SELF is specified. Use SELF for stack sets with - self-managed permissions. - -
  • - - If you are signed in to the management account, specify SELF. - -
  • - - If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. - - - - Your AWS account must be registered as a delegated administrator in the management - account. For more information, see Register - a delegated administrator in the AWS CloudFormation User Guide. - -
- - - - - Gets and sets the property Capabilities. - - In some cases, you must explicitly acknowledge that your stack template contains certain - capabilities in order for AWS CloudFormation to update the stack set and its associated - stack instances. - -
  • - - CAPABILITY_IAM and CAPABILITY_NAMED_IAM - - - - Some stack templates might include resources that can affect permissions in your AWS - account; for example, by creating new AWS Identity and Access Management (IAM) users. - For those stacks sets, you must explicitly acknowledge this by specifying one of these - capabilities. - - - - The following IAM resources require you to specify either the CAPABILITY_IAM - or CAPABILITY_NAMED_IAM capability. - -
    • - - If you have IAM resources, you can specify either capability. - -
    • - - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. - - -
    • - - If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities - error. - -
    - - If your stack template contains these resources, we recommend that you review all - permissions associated with them and edit their permissions if necessary. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - -
  • - - CAPABILITY_AUTO_EXPAND - - - - Some templates reference macros. If your stack set template references one or more - macros, you must update the stack set directly from the processed template, without - first reviewing the resulting changes in a change set. To update the stack set directly, - you must acknowledge this capability. For more information, see Using - AWS CloudFormation Macros to Perform Custom Processing on Templates. - - - - Stack sets with service-managed permissions do not currently support the use of macros - in templates. (This includes the AWS::Include - and AWS::Serverless - transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this - capability for a stack set with service-managed permissions, if you reference a macro - in your template the stack set operation will fail. - -
- - - - - Gets and sets the property DeploymentTargets. - - [Service-managed permissions] The AWS Organizations accounts in which to update associated - stack instances. - - - - To update all the stack instances associated with this stack set, do not specify DeploymentTargets - or Regions. - - - - If the stack set update includes changes to the template (that is, if TemplateBody - or TemplateURL is specified), or the Parameters, AWS CloudFormation - marks all stack instances with a status of OUTDATED prior to updating - the stack instances in the specified accounts and Regions. If the stack set update - does not include changes to the template or parameters, AWS CloudFormation updates - the stack instances in the specified accounts and Regions, while leaving all other - stack instances with their existing stack instance status. - - - - - - Gets and sets the property Description. - - A brief description of updates that you are making. - - - - - - Gets and sets the property ExecutionRoleName. - - The name of the IAM execution role to use to update the stack set. If you do not specify - an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole - role for the stack set operation. - - - - Specify an IAM role only if you are using customized execution roles to control which - stack resources users and groups can include in their stack sets. - - - - If you specify a customized execution role, AWS CloudFormation uses that role to - update the stack. If you do not specify a customized execution role, AWS CloudFormation - performs the update using the role previously associated with the stack set, so long - as you have permissions to perform operations on the stack set. - - - - - - Gets and sets the property OperationId. - - The unique ID for this stack set operation. - - - - The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation - performs the stack set operation only once, even if you retry the request multiple - times. You might retry stack set operation requests to ensure that AWS CloudFormation - successfully received them. - - - - If you don't specify an operation ID, AWS CloudFormation generates one automatically. - - - - Repeating this stack set operation with a new operation ID retries all stack instances - whose status is OUTDATED. - - - - - - Gets and sets the property OperationPreferences. - - Preferences for how AWS CloudFormation performs this stack set operation. - - - - - - Gets and sets the property Parameters. - - A list of input parameters for the stack set template. - - - - - - Gets and sets the property PermissionModel. - - Describes how the IAM roles required for stack set operations are created. You cannot - modify PermissionModel if there are stack instances associated with your - stack set. - - - - - - - Gets and sets the property Regions. - - The Regions in which to update associated stack instances. If you specify Regions, - you must also specify accounts in which to update stack set instances. - - - - To update all the stack instances associated with this stack set, do not specify - the Accounts or Regions properties. - - - - If the stack set update includes changes to the template (that is, if the TemplateBody - or TemplateURL properties are specified), or the Parameters - property, AWS CloudFormation marks all stack instances with a status of OUTDATED - prior to updating the stack instances in the specified accounts and Regions. If the - stack set update does not include changes to the template or parameters, AWS CloudFormation - updates the stack instances in the specified accounts and Regions, while leaving all - other stack instances with their existing stack instance status. - - - - - - Gets and sets the property StackSetName. - - The name or unique ID of the stack set that you want to update. - - - - - - Gets and sets the property Tags. - - The key-value pairs to associate with this stack set and the stacks created from it. - AWS CloudFormation also propagates these tags to supported resources that are created - in the stacks. You can specify a maximum number of 50 tags. - - - - If you specify tags for this parameter, those tags replace any list of tags that are - currently associated with this stack set. This means: - -
  • - - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's - tags. - -
  • - - If you specify any tags using this parameter, you must specify all the - tags that you want associated with this stack set, even tags you've specifed before - (for example, when creating the stack set or during a previous update of the stack - set.). Any tags that you don't include in the updated list of tags are removed from - the stack set, and therefore from the stacks and resources as well. - -
  • - - If you specify an empty value, AWS CloudFormation removes all currently associated - tags. - -
- - If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation - checks to see if you have the required IAM permission to tag resources. If you omit - tags that are currently associated with the stack set from the list of tags you specify, - AWS CloudFormation assumes that you want to remove those tags from the stack set, - and checks to see if you have permission to untag resources. If you don't have the - necessary permission(s), the entire UpdateStackSet action fails with - an access denied error, and the stack set is not updated. - - - - - - Gets and sets the property TemplateBody. - - The structure that contains the template body, with a minimum length of 1 byte and - a maximum length of 51,200 bytes. For more information, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify only one of the following parameters: TemplateBody - or TemplateURL—or set UsePreviousTemplate to true. - - - - - - Gets and sets the property TemplateURL. - - The location of the file that contains the template body. The URL must point to a - template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a - Systems Manager document. For more information, see Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must specify only one of the following parameters: TemplateBody - or TemplateURL—or set UsePreviousTemplate to true. - - - - - - Gets and sets the property UsePreviousTemplate. - - Use the existing template that's associated with the stack set that you're updating. - - - - Conditional: You must specify only one of the following parameters: TemplateBody - or TemplateURL—or set UsePreviousTemplate to true. - - - - - - This is the response object from the UpdateStackSet operation. - - - - - Gets and sets the property OperationId. - - The unique ID for this stack set operation. - - - - - - Container for the parameters to the UpdateTerminationProtection operation. - Updates termination protection for the specified stack. If a user attempts to delete - a stack with termination protection enabled, the operation fails and the stack remains - unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - - - - Gets and sets the property EnableTerminationProtection. - - Whether to enable termination protection on the specified stack. - - - - - - Gets and sets the property StackName. - - The name or unique ID of the stack for which you want to set termination protection. - - - - - - This is the response object from the UpdateTerminationProtection operation. - - - - - Gets and sets the property StackId. - - The unique ID of the stack. - - - - - - Container for the parameters to the ValidateTemplate operation. - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - - - - Gets and sets the property TemplateBody. - - Structure containing the template body with a minimum length of 1 byte and a maximum - length of 51,200 bytes. For more information, go to Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must pass TemplateURL or TemplateBody. - If both are passed, only TemplateBody is used. - - - - - - Gets and sets the property TemplateURL. - - Location of file containing the template body. The URL must point to a template (max - size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. - For more information, go to Template - Anatomy in the AWS CloudFormation User Guide. - - - - Conditional: You must pass TemplateURL or TemplateBody. - If both are passed, only TemplateBody is used. - - - - - - The output for ValidateTemplate action. - - - - - Gets and sets the property Capabilities. - - The capabilities found within the template. If your template contains IAM resources, - you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter - when you use the CreateStack or UpdateStack actions with your template; - otherwise, those actions return an InsufficientCapabilities error. - - - - For more information, see Acknowledging - IAM Resources in AWS CloudFormation Templates. - - - - - - Gets and sets the property CapabilitiesReason. - - The list of resources that generated the values in the Capabilities response - element. - - - - - - Gets and sets the property DeclaredTransforms. - - A list of the transforms that are declared in the template. - - - - - - Gets and sets the property Description. - - The description found within the template. - - - - - - Gets and sets the property Parameters. - - A list of TemplateParameter structures. - - - - - - Paginators for the CloudFormation service - - - - - Paginator for DescribeAccountLimits operation - - - - - Paginator for DescribeStackEvents operation - - - - - Paginator for DescribeStackResourceDrifts operation - - - - - Paginator for DescribeStacks operation - - - - - Paginator for ListChangeSets operation - - - - - Paginator for ListExports operation - - - - - Paginator for ListImports operation - - - - - Paginator for ListStackInstances operation - - - - - Paginator for ListStackResources operation - - - - - Paginator for ListStacks operation - - - - - Paginator for ListStackSetOperationResults operation - - - - - Paginator for ListStackSetOperations operation - - - - - Paginator for ListStackSets operation - - - - - Paginator for ListTypeRegistrations operation - - - - - Paginator for ListTypes operation - - - - - Paginator for ListTypeVersions operation - - - - - Base class for DescribeAccountLimits paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the AccountLimits - - - - - Base class for DescribeStackEvents paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackEvents - - - - - Base class for DescribeStackResourceDrifts paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Base class for DescribeStacks paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Stacks - - - - - Paginators for the CloudFormation service - - - - - Paginator for DescribeAccountLimits operation - - - - - Paginator for DescribeStackEvents operation - - - - - Paginator for DescribeStackResourceDrifts operation - - - - - Paginator for DescribeStacks operation - - - - - Paginator for ListChangeSets operation - - - - - Paginator for ListExports operation - - - - - Paginator for ListImports operation - - - - - Paginator for ListStackInstances operation - - - - - Paginator for ListStackResources operation - - - - - Paginator for ListStacks operation - - - - - Paginator for ListStackSetOperationResults operation - - - - - Paginator for ListStackSetOperations operation - - - - - Paginator for ListStackSets operation - - - - - Paginator for ListTypeRegistrations operation - - - - - Paginator for ListTypes operation - - - - - Paginator for ListTypeVersions operation - - - - - Paginator for the DescribeAccountLimits operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the AccountLimits - - - - - Paginator for the DescribeStackEvents operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackEvents - - - - - Paginator for the DescribeStackResourceDrifts operation - - - - - Enumerable containing all full responses for the operation - - - - - Paginator for the DescribeStacks operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Stacks - - - - - Paginator for the ListChangeSets operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Paginator for the ListExports operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Exports - - - - - Paginator for the ListImports operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Imports - - - - - Paginator for the ListStackInstances operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Paginator for the ListStackResources operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackResourceSummaries - - - - - Paginator for the ListStackSetOperationResults operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Paginator for the ListStackSetOperations operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Paginator for the ListStackSets operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Paginator for the ListStacks operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackSummaries - - - - - Paginator for the ListTypeRegistrations operation - - - - - Enumerable containing all full responses for the operation - - - - - Paginator for the ListTypes operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the TypeSummaries - - - - - Paginator for the ListTypeVersions operation - - - - - Enumerable containing all full responses for the operation - - - - - Base class for ListChangeSets paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Base class for ListExports paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Exports - - - - - Base class for ListImports paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Imports - - - - - Base class for ListStackInstances paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Base class for ListStackResources paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackResourceSummaries - - - - - Base class for ListStackSetOperationResults paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Base class for ListStackSetOperations paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Base class for ListStackSets paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Summaries - - - - - Base class for ListStacks paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the StackSummaries - - - - - Base class for ListTypeRegistrations paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Base class for ListTypes paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the TypeSummaries - - - - - Base class for ListTypeVersions paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Utility methods for CloudFormation. - - - - - This method will signal to the CloudFormation the status of a wait condition. - - The URL returned from the creation of a WaitHandle in a CloudFormation Stack - SUCCESS or FAILURE for the status of a stack - The reason for the status - A unique identifier for the signal. Using Guid.NewGuid().ToString()can be used for this. - Data to be passed back for later use in the template. - - - - Configuration for accessing Amazon CloudFormation service - - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Common exception for the CloudFormation service. - - - - - Construct instance of AmazonCloudFormationException - - - - - - Construct instance of AmazonCloudFormationException - - - - - - - Construct instance of AmazonCloudFormationException - - - - - - Construct instance of AmazonCloudFormationException - - - - - - - - - - Construct instance of AmazonCloudFormationException - - - - - - - - - - - Constructs a new instance of the AmazonCloudFormationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Base class for CloudFormation operation requests. - - - - - Constants used for properties of type AccountGateStatus. - - - - - Constant FAILED for AccountGateStatus - - - - - Constant SKIPPED for AccountGateStatus - - - - - Constant SUCCEEDED for AccountGateStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type CallAs. - - - - - Constant DELEGATED_ADMIN for CallAs - - - - - Constant SELF for CallAs - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type Capability. - - - - - Constant CAPABILITY_AUTO_EXPAND for Capability - - - - - Constant CAPABILITY_IAM for Capability - - - - - Constant CAPABILITY_NAMED_IAM for Capability - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type Category. - - - - - Constant ACTIVATED for Category - - - - - Constant AWS_TYPES for Category - - - - - Constant REGISTERED for Category - - - - - Constant THIRD_PARTY for Category - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChangeAction. - - - - - Constant Add for ChangeAction - - - - - Constant Dynamic for ChangeAction - - - - - Constant Import for ChangeAction - - - - - Constant Modify for ChangeAction - - - - - Constant Remove for ChangeAction - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChangeSetStatus. - - - - - Constant CREATE_COMPLETE for ChangeSetStatus - - - - - Constant CREATE_IN_PROGRESS for ChangeSetStatus - - - - - Constant CREATE_PENDING for ChangeSetStatus - - - - - Constant DELETE_COMPLETE for ChangeSetStatus - - - - - Constant DELETE_FAILED for ChangeSetStatus - - - - - Constant DELETE_IN_PROGRESS for ChangeSetStatus - - - - - Constant DELETE_PENDING for ChangeSetStatus - - - - - Constant FAILED for ChangeSetStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChangeSetType. - - - - - Constant CREATE for ChangeSetType - - - - - Constant IMPORT for ChangeSetType - - - - - Constant UPDATE for ChangeSetType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChangeSource. - - - - - Constant Automatic for ChangeSource - - - - - Constant DirectModification for ChangeSource - - - - - Constant ParameterReference for ChangeSource - - - - - Constant ResourceAttribute for ChangeSource - - - - - Constant ResourceReference for ChangeSource - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChangeType. - - - - - Constant Resource for ChangeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DeprecatedStatus. - - - - - Constant DEPRECATED for DeprecatedStatus - - - - - Constant LIVE for DeprecatedStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DifferenceType. - - - - - Constant ADD for DifferenceType - - - - - Constant NOT_EQUAL for DifferenceType - - - - - Constant REMOVE for DifferenceType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EvaluationType. - - - - - Constant Dynamic for EvaluationType - - - - - Constant Static for EvaluationType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ExecutionStatus. - - - - - Constant AVAILABLE for ExecutionStatus - - - - - Constant EXECUTE_COMPLETE for ExecutionStatus - - - - - Constant EXECUTE_FAILED for ExecutionStatus - - - - - Constant EXECUTE_IN_PROGRESS for ExecutionStatus - - - - - Constant OBSOLETE for ExecutionStatus - - - - - Constant UNAVAILABLE for ExecutionStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type HandlerErrorCode. - - - - - Constant AccessDenied for HandlerErrorCode - - - - - Constant AlreadyExists for HandlerErrorCode - - - - - Constant GeneralServiceException for HandlerErrorCode - - - - - Constant InternalFailure for HandlerErrorCode - - - - - Constant InvalidCredentials for HandlerErrorCode - - - - - Constant InvalidRequest for HandlerErrorCode - - - - - Constant InvalidTypeConfiguration for HandlerErrorCode - - - - - Constant NetworkFailure for HandlerErrorCode - - - - - Constant NotFound for HandlerErrorCode - - - - - Constant NotStabilized for HandlerErrorCode - - - - - Constant NotUpdatable for HandlerErrorCode - - - - - Constant ResourceConflict for HandlerErrorCode - - - - - Constant ServiceInternalError for HandlerErrorCode - - - - - Constant ServiceLimitExceeded for HandlerErrorCode - - - - - Constant Throttling for HandlerErrorCode - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type IdentityProvider. - - - - - Constant AWS_Marketplace for IdentityProvider - - - - - Constant Bitbucket for IdentityProvider - - - - - Constant GitHub for IdentityProvider - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type OnFailure. - - - - - Constant DELETE for OnFailure - - - - - Constant DO_NOTHING for OnFailure - - - - - Constant ROLLBACK for OnFailure - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type OperationStatus. - - - - - Constant FAILED for OperationStatus - - - - - Constant IN_PROGRESS for OperationStatus - - - - - Constant PENDING for OperationStatus - - - - - Constant SUCCESS for OperationStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PermissionModels. - - - - - Constant SELF_MANAGED for PermissionModels - - - - - Constant SERVICE_MANAGED for PermissionModels - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ProvisioningType. - - - - - Constant FULLY_MUTABLE for ProvisioningType - - - - - Constant IMMUTABLE for ProvisioningType - - - - - Constant NON_PROVISIONABLE for ProvisioningType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PublisherStatus. - - - - - Constant UNVERIFIED for PublisherStatus - - - - - Constant VERIFIED for PublisherStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RegionConcurrencyType. - - - - - Constant PARALLEL for RegionConcurrencyType - - - - - Constant SEQUENTIAL for RegionConcurrencyType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RegistrationStatus. - - - - - Constant COMPLETE for RegistrationStatus - - - - - Constant FAILED for RegistrationStatus - - - - - Constant IN_PROGRESS for RegistrationStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RegistryType. - - - - - Constant MODULE for RegistryType - - - - - Constant RESOURCE for RegistryType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type Replacement. - - - - - Constant Conditional for Replacement - - - - - Constant False for Replacement - - - - - Constant True for Replacement - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RequiresRecreation. - - - - - Constant Always for RequiresRecreation - - - - - Constant Conditionally for RequiresRecreation - - - - - Constant Never for RequiresRecreation - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ResourceAttribute. - - - - - Constant CreationPolicy for ResourceAttribute - - - - - Constant DeletionPolicy for ResourceAttribute - - - - - Constant Metadata for ResourceAttribute - - - - - Constant Properties for ResourceAttribute - - - - - Constant Tags for ResourceAttribute - - - - - Constant UpdatePolicy for ResourceAttribute - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ResourceSignalStatus. - - - - - Constant FAILURE for ResourceSignalStatus - - - - - Constant SUCCESS for ResourceSignalStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ResourceStatus. - - - - - Constant CREATE_COMPLETE for ResourceStatus - - - - - Constant CREATE_FAILED for ResourceStatus - - - - - Constant CREATE_IN_PROGRESS for ResourceStatus - - - - - Constant DELETE_COMPLETE for ResourceStatus - - - - - Constant DELETE_FAILED for ResourceStatus - - - - - Constant DELETE_IN_PROGRESS for ResourceStatus - - - - - Constant DELETE_SKIPPED for ResourceStatus - - - - - Constant IMPORT_COMPLETE for ResourceStatus - - - - - Constant IMPORT_FAILED for ResourceStatus - - - - - Constant IMPORT_IN_PROGRESS for ResourceStatus - - - - - Constant IMPORT_ROLLBACK_COMPLETE for ResourceStatus - - - - - Constant IMPORT_ROLLBACK_FAILED for ResourceStatus - - - - - Constant IMPORT_ROLLBACK_IN_PROGRESS for ResourceStatus - - - - - Constant UPDATE_COMPLETE for ResourceStatus - - - - - Constant UPDATE_FAILED for ResourceStatus - - - - - Constant UPDATE_IN_PROGRESS for ResourceStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackDriftDetectionStatus. - - - - - Constant DETECTION_COMPLETE for StackDriftDetectionStatus - - - - - Constant DETECTION_FAILED for StackDriftDetectionStatus - - - - - Constant DETECTION_IN_PROGRESS for StackDriftDetectionStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackDriftStatus. - - - - - Constant DRIFTED for StackDriftStatus - - - - - Constant IN_SYNC for StackDriftStatus - - - - - Constant NOT_CHECKED for StackDriftStatus - - - - - Constant UNKNOWN for StackDriftStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackInstanceDetailedStatus. - - - - - Constant CANCELLED for StackInstanceDetailedStatus - - - - - Constant FAILED for StackInstanceDetailedStatus - - - - - Constant INOPERABLE for StackInstanceDetailedStatus - - - - - Constant PENDING for StackInstanceDetailedStatus - - - - - Constant RUNNING for StackInstanceDetailedStatus - - - - - Constant SUCCEEDED for StackInstanceDetailedStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackInstanceFilterName. - - - - - Constant DETAILED_STATUS for StackInstanceFilterName - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackInstanceStatus. - - - - - Constant CURRENT for StackInstanceStatus - - - - - Constant INOPERABLE for StackInstanceStatus - - - - - Constant OUTDATED for StackInstanceStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackResourceDriftStatus. - - - - - Constant DELETED for StackResourceDriftStatus - - - - - Constant IN_SYNC for StackResourceDriftStatus - - - - - Constant MODIFIED for StackResourceDriftStatus - - - - - Constant NOT_CHECKED for StackResourceDriftStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetDriftDetectionStatus. - - - - - Constant COMPLETED for StackSetDriftDetectionStatus - - - - - Constant FAILED for StackSetDriftDetectionStatus - - - - - Constant IN_PROGRESS for StackSetDriftDetectionStatus - - - - - Constant PARTIAL_SUCCESS for StackSetDriftDetectionStatus - - - - - Constant STOPPED for StackSetDriftDetectionStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetDriftStatus. - - - - - Constant DRIFTED for StackSetDriftStatus - - - - - Constant IN_SYNC for StackSetDriftStatus - - - - - Constant NOT_CHECKED for StackSetDriftStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetOperationAction. - - - - - Constant CREATE for StackSetOperationAction - - - - - Constant DELETE for StackSetOperationAction - - - - - Constant DETECT_DRIFT for StackSetOperationAction - - - - - Constant UPDATE for StackSetOperationAction - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetOperationResultStatus. - - - - - Constant CANCELLED for StackSetOperationResultStatus - - - - - Constant FAILED for StackSetOperationResultStatus - - - - - Constant PENDING for StackSetOperationResultStatus - - - - - Constant RUNNING for StackSetOperationResultStatus - - - - - Constant SUCCEEDED for StackSetOperationResultStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetOperationStatus. - - - - - Constant FAILED for StackSetOperationStatus - - - - - Constant QUEUED for StackSetOperationStatus - - - - - Constant RUNNING for StackSetOperationStatus - - - - - Constant STOPPED for StackSetOperationStatus - - - - - Constant STOPPING for StackSetOperationStatus - - - - - Constant SUCCEEDED for StackSetOperationStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackSetStatus. - - - - - Constant ACTIVE for StackSetStatus - - - - - Constant DELETED for StackSetStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StackStatus. - - - - - Constant CREATE_COMPLETE for StackStatus - - - - - Constant CREATE_FAILED for StackStatus - - - - - Constant CREATE_IN_PROGRESS for StackStatus - - - - - Constant DELETE_COMPLETE for StackStatus - - - - - Constant DELETE_FAILED for StackStatus - - - - - Constant DELETE_IN_PROGRESS for StackStatus - - - - - Constant IMPORT_COMPLETE for StackStatus - - - - - Constant IMPORT_IN_PROGRESS for StackStatus - - - - - Constant IMPORT_ROLLBACK_COMPLETE for StackStatus - - - - - Constant IMPORT_ROLLBACK_FAILED for StackStatus - - - - - Constant IMPORT_ROLLBACK_IN_PROGRESS for StackStatus - - - - - Constant REVIEW_IN_PROGRESS for StackStatus - - - - - Constant ROLLBACK_COMPLETE for StackStatus - - - - - Constant ROLLBACK_FAILED for StackStatus - - - - - Constant ROLLBACK_IN_PROGRESS for StackStatus - - - - - Constant UPDATE_COMPLETE for StackStatus - - - - - Constant UPDATE_COMPLETE_CLEANUP_IN_PROGRESS for StackStatus - - - - - Constant UPDATE_IN_PROGRESS for StackStatus - - - - - Constant UPDATE_ROLLBACK_COMPLETE for StackStatus - - - - - Constant UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS for StackStatus - - - - - Constant UPDATE_ROLLBACK_FAILED for StackStatus - - - - - Constant UPDATE_ROLLBACK_IN_PROGRESS for StackStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type TemplateStage. - - - - - Constant Original for TemplateStage - - - - - Constant Processed for TemplateStage - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ThirdPartyType. - - - - - Constant MODULE for ThirdPartyType - - - - - Constant RESOURCE for ThirdPartyType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type TypeTestsStatus. - - - - - Constant FAILED for TypeTestsStatus - - - - - Constant IN_PROGRESS for TypeTestsStatus - - - - - Constant NOT_TESTED for TypeTestsStatus - - - - - Constant PASSED for TypeTestsStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type VersionBump. - - - - - Constant MAJOR for VersionBump - - - - - Constant MINOR for VersionBump - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type Visibility. - - - - - Constant PRIVATE for Visibility - - - - - Constant PUBLIC for Visibility - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Implementation for accessing CloudFormation - - AWS CloudFormation - - AWS CloudFormation allows you to create and manage AWS infrastructure deployments - predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, - such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification - Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly - scalable, cost-effective applications without creating or configuring the underlying - AWS infrastructure. - - - - With AWS CloudFormation, you declare all of your resources and dependencies in a template - file. The template defines a collection of resources as a single unit called a stack. - AWS CloudFormation creates and deletes all member resources of the stack together - and manages all dependencies between the resources for you. - - - - For more information about AWS CloudFormation, see the AWS - CloudFormation Product Page. - - - - Amazon CloudFormation makes use of other AWS products. If you need additional technical - information about a specific AWS product, you can find the product's technical documentation - at docs.aws.amazon.com. - - - - - - Paginators for the service - - - - - Constructs AmazonCloudFormationClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonCloudFormationClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonCloudFormationClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonCloudFormationClient Configuration Object - - - - Constructs AmazonCloudFormationClient with AWS Credentials - - AWS Credentials - - - - Constructs AmazonCloudFormationClient with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonCloudFormationClient with AWS Credentials and an - AmazonCloudFormationClient Configuration object. - - AWS Credentials - The AmazonCloudFormationClient Configuration Object - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an - AmazonCloudFormationClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonCloudFormationClient Configuration Object - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an - AmazonCloudFormationClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonCloudFormationClient Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - Activates a public third-party extension, making it available for use in stack templates. - For more information, see Using - public extensions in the CloudFormation User Guide. - - - - Once you have activated a public third-party extension in your account and region, - use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the ActivateType service method. - - The response from the ActivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for ActivateType Operation - - - - Activates a public third-party extension, making it available for use in stack templates. - For more information, see Using - public extensions in the CloudFormation User Guide. - - - - Once you have activated a public third-party extension in your account and region, - use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the ActivateType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ActivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for ActivateType Operation - - - - Returns configuration data for the specified CloudFormation extensions, from the CloudFormation - registry for the account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the BatchDescribeTypeConfigurations service method. - - The response from the BatchDescribeTypeConfigurations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension configuration cannot be found. - - REST API Reference for BatchDescribeTypeConfigurations Operation - - - - Returns configuration data for the specified CloudFormation extensions, from the CloudFormation - registry for the account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the BatchDescribeTypeConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the BatchDescribeTypeConfigurations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension configuration cannot be found. - - REST API Reference for BatchDescribeTypeConfigurations Operation - - - - Cancels an update on the specified stack. If the call completes successfully, the - stack rolls back the update and reverts to the previous stack configuration. - - - - You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. - - - - Container for the necessary parameters to execute the CancelUpdateStack service method. - - The response from the CancelUpdateStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for CancelUpdateStack Operation - - - - Cancels an update on the specified stack. If the call completes successfully, the - stack rolls back the update and reverts to the previous stack configuration. - - - - You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. - - - - Container for the necessary parameters to execute the CancelUpdateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CancelUpdateStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for CancelUpdateStack Operation - - - - For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues - rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the - cause of the failure, you can manually - fix the error and continue the rollback. By continuing the rollback, you can return - your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - then try to update the stack again. - - - - A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation - cannot roll back all changes after a failed stack update. For example, you might have - a stack that is rolling back to an old database instance that was deleted outside - of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, - it assumes that the database instance still exists and attempts to roll back to it, - causing the update rollback to fail. - - - Container for the necessary parameters to execute the ContinueUpdateRollback service method. - - The response from the ContinueUpdateRollback service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for ContinueUpdateRollback Operation - - - - For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues - rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the - cause of the failure, you can manually - fix the error and continue the rollback. By continuing the rollback, you can return - your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - then try to update the stack again. - - - - A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation - cannot roll back all changes after a failed stack update. For example, you might have - a stack that is rolling back to an old database instance that was deleted outside - of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, - it assumes that the database instance still exists and attempts to roll back to it, - causing the update rollback to fail. - - - Container for the necessary parameters to execute the ContinueUpdateRollback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ContinueUpdateRollback service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for ContinueUpdateRollback Operation - - - - Creates a list of changes that will be applied to a stack so that you can review the - changes before executing them. You can create a change set for a stack that doesn't - exist or an existing stack. If you create a change set for a stack that doesn't exist, - the change set shows all of the resources that AWS CloudFormation will create. If - you create a change set for an existing stack, AWS CloudFormation compares the stack's - information with the information that you submit in the change set and lists the differences. - Use change sets to understand which resources AWS CloudFormation will create or change, - and how it will change resources in an existing stack, before you create or update - a stack. - - - - To create a change set for a stack that doesn't exist, for the ChangeSetType - parameter, specify CREATE. To create a change set for an existing stack, - specify UPDATE for the ChangeSetType parameter. To create - a change set for an import operation, specify IMPORT for the ChangeSetType - parameter. After the CreateChangeSet call successfully completes, AWS - CloudFormation starts creating the change set. To check the status of the change set - or to review it, use the DescribeChangeSet action. - - - - When you are satisfied with the changes the change set will make, execute the change - set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes - until you execute the change set. - - - - To create a change set for the entire stack hierachy, set IncludeNestedStacks - to True. - - - Container for the necessary parameters to execute the CreateChangeSet service method. - - The response from the CreateChangeSet service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - REST API Reference for CreateChangeSet Operation - - - - Creates a list of changes that will be applied to a stack so that you can review the - changes before executing them. You can create a change set for a stack that doesn't - exist or an existing stack. If you create a change set for a stack that doesn't exist, - the change set shows all of the resources that AWS CloudFormation will create. If - you create a change set for an existing stack, AWS CloudFormation compares the stack's - information with the information that you submit in the change set and lists the differences. - Use change sets to understand which resources AWS CloudFormation will create or change, - and how it will change resources in an existing stack, before you create or update - a stack. - - - - To create a change set for a stack that doesn't exist, for the ChangeSetType - parameter, specify CREATE. To create a change set for an existing stack, - specify UPDATE for the ChangeSetType parameter. To create - a change set for an import operation, specify IMPORT for the ChangeSetType - parameter. After the CreateChangeSet call successfully completes, AWS - CloudFormation starts creating the change set. To check the status of the change set - or to review it, use the DescribeChangeSet action. - - - - When you are satisfied with the changes the change set will make, execute the change - set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes - until you execute the change set. - - - - To create a change set for the entire stack hierachy, set IncludeNestedStacks - to True. - - - Container for the necessary parameters to execute the CreateChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateChangeSet service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - REST API Reference for CreateChangeSet Operation - - - - Creates a stack as specified in the template. After the call completes successfully, - the stack creation starts. You can check the status of the stack via the DescribeStacks - API. - - Container for the necessary parameters to execute the CreateStack service method. - - The response from the CreateStack service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - A client request token already exists. - - REST API Reference for CreateStack Operation - - - - Creates a stack as specified in the template. After the call completes successfully, - the stack creation starts. You can check the status of the stack via the DescribeStacks - API. - - Container for the necessary parameters to execute the CreateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStack service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - A client request token already exists. - - REST API Reference for CreateStack Operation - - - - Creates stack instances for the specified accounts, within the specified Regions. - A stack instance refers to a stack in a specific account and Region. You must specify - at least one value for either Accounts or DeploymentTargets, - and you must specify at least one value for Regions. - - Container for the necessary parameters to execute the CreateStackInstances service method. - - The response from the CreateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for CreateStackInstances Operation - - - - Creates stack instances for the specified accounts, within the specified Regions. - A stack instance refers to a stack in a specific account and Region. You must specify - at least one value for either Accounts or DeploymentTargets, - and you must specify at least one value for Regions. - - Container for the necessary parameters to execute the CreateStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for CreateStackInstances Operation - - - - Creates a stack set. - - Container for the necessary parameters to execute the CreateStackSet service method. - - The response from the CreateStackSet service method, as returned by CloudFormation. - - The specified resource exists, but has been changed. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified name is already in use. - - REST API Reference for CreateStackSet Operation - - - - Creates a stack set. - - Container for the necessary parameters to execute the CreateStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStackSet service method, as returned by CloudFormation. - - The specified resource exists, but has been changed. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified name is already in use. - - REST API Reference for CreateStackSet Operation - - - - Deactivates a public extension that was previously activated in this account and region. - - - - Once deactivated, an extension cannot be used in any CloudFormation operation. This - includes stack update operations where the stack template includes the extension, - even if no updates are being made to the extension. In addition, deactivated extensions - are not automatically updated if a new version of the extension is released. - - - Container for the necessary parameters to execute the DeactivateType service method. - - The response from the DeactivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeactivateType Operation - - - - Deactivates a public extension that was previously activated in this account and region. - - - - Once deactivated, an extension cannot be used in any CloudFormation operation. This - includes stack update operations where the stack template includes the extension, - even if no updates are being made to the extension. In addition, deactivated extensions - are not automatically updated if a new version of the extension is released. - - - Container for the necessary parameters to execute the DeactivateType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeactivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeactivateType Operation - - - - Deletes the specified change set. Deleting change sets ensures that no one executes - the wrong change set. - - - - If the call successfully completes, AWS CloudFormation successfully deleted the change - set. - - - - If IncludeNestedStacks specifies True during the creation - of the nested change set, then DeleteChangeSet will delete all change - sets that belong to the stacks hierarchy and will also delete all change sets for - nested stacks with the status of REVIEW_IN_PROGRESS. - - - Container for the necessary parameters to execute the DeleteChangeSet service method. - - The response from the DeleteChangeSet service method, as returned by CloudFormation. - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - REST API Reference for DeleteChangeSet Operation - - - - Deletes the specified change set. Deleting change sets ensures that no one executes - the wrong change set. - - - - If the call successfully completes, AWS CloudFormation successfully deleted the change - set. - - - - If IncludeNestedStacks specifies True during the creation - of the nested change set, then DeleteChangeSet will delete all change - sets that belong to the stacks hierarchy and will also delete all change sets for - nested stacks with the status of REVIEW_IN_PROGRESS. - - - Container for the necessary parameters to execute the DeleteChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteChangeSet service method, as returned by CloudFormation. - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - REST API Reference for DeleteChangeSet Operation - - - - Deletes a specified stack. Once the call completes successfully, stack deletion starts. - Deleted stacks do not show up in the DescribeStacks API if the deletion has - been completed successfully. - - Container for the necessary parameters to execute the DeleteStack service method. - - The response from the DeleteStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for DeleteStack Operation - - - - Deletes a specified stack. Once the call completes successfully, stack deletion starts. - Deleted stacks do not show up in the DescribeStacks API if the deletion has - been completed successfully. - - Container for the necessary parameters to execute the DeleteStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for DeleteStack Operation - - - - Deletes stack instances for the specified accounts, in the specified Regions. - - Container for the necessary parameters to execute the DeleteStackInstances service method. - - The response from the DeleteStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for DeleteStackInstances Operation - - - - Deletes stack instances for the specified accounts, in the specified Regions. - - Container for the necessary parameters to execute the DeleteStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for DeleteStackInstances Operation - - - - Deletes a stack set. Before you can delete a stack set, all of its member stack instances - must be deleted. For more information about how to do this, see DeleteStackInstances. - - Container for the necessary parameters to execute the DeleteStackSet service method. - - The response from the DeleteStackSet service method, as returned by CloudFormation. - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - You can't yet delete this stack set, because it still contains one or more stack instances. - Delete all stack instances from the stack set before deleting the stack set. - - REST API Reference for DeleteStackSet Operation - - - - Deletes a stack set. Before you can delete a stack set, all of its member stack instances - must be deleted. For more information about how to do this, see DeleteStackInstances. - - Container for the necessary parameters to execute the DeleteStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStackSet service method, as returned by CloudFormation. - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - You can't yet delete this stack set, because it still contains one or more stack instances. - Delete all stack instances from the stack set before deleting the stack set. - - REST API Reference for DeleteStackSet Operation - - - - Marks an extension or extension version as DEPRECATED in the CloudFormation - registry, removing it from active use. Deprecated extensions or extension versions - cannot be used in CloudFormation operations. - - - - To deregister an entire extension, you must individually deregister all active versions - of that extension. If an extension has only a single active version, deregistering - that version results in the extension itself being deregistered and marked as deprecated - in the registry. - - - - You cannot deregister the default version of an extension if there are other active - version of that extension. If you do deregister the default version of an extension, - the textensionype itself is deregistered as well and marked as deprecated. - - - - To view the deprecation status of an extension or extension version, use DescribeType. - - - Container for the necessary parameters to execute the DeregisterType service method. - - The response from the DeregisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeregisterType Operation - - - - Marks an extension or extension version as DEPRECATED in the CloudFormation - registry, removing it from active use. Deprecated extensions or extension versions - cannot be used in CloudFormation operations. - - - - To deregister an entire extension, you must individually deregister all active versions - of that extension. If an extension has only a single active version, deregistering - that version results in the extension itself being deregistered and marked as deprecated - in the registry. - - - - You cannot deregister the default version of an extension if there are other active - version of that extension. If you do deregister the default version of an extension, - the textensionype itself is deregistered as well and marked as deprecated. - - - - To view the deprecation status of an extension or extension version, use DescribeType. - - - Container for the necessary parameters to execute the DeregisterType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeregisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeregisterType Operation - - - - Retrieves your account's AWS CloudFormation limits, such as the maximum number of - stacks that you can create in your account. For more information about account limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeAccountLimits service method. - - The response from the DescribeAccountLimits service method, as returned by CloudFormation. - REST API Reference for DescribeAccountLimits Operation - - - - Retrieves your account's AWS CloudFormation limits, such as the maximum number of - stacks that you can create in your account. For more information about account limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeAccountLimits service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAccountLimits service method, as returned by CloudFormation. - REST API Reference for DescribeAccountLimits Operation - - - - Returns the inputs for the change set and a list of changes that AWS CloudFormation - will make if you execute the change set. For more information, see Updating - Stacks Using Change Sets in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeChangeSet service method. - - The response from the DescribeChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for DescribeChangeSet Operation - - - - Returns the inputs for the change set and a list of changes that AWS CloudFormation - will make if you execute the change set. For more information, see Updating - Stacks Using Change Sets in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for DescribeChangeSet Operation - - - - Returns information about a CloudFormation extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - For more information on registering as a publisher, see: - - - - Container for the necessary parameters to execute the DescribePublisher service method. - - The response from the DescribePublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribePublisher Operation - - - - Returns information about a CloudFormation extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - For more information on registering as a publisher, see: - - - - Container for the necessary parameters to execute the DescribePublisher service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribePublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribePublisher Operation - - - - Returns information about a stack drift detection operation. A stack drift detection - operation detects whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. A stack is considered to have drifted if one or - more of its resources have drifted. For more information on stack and resource drift, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift - returns a StackDriftDetectionId you can use to monitor the progress of - the operation using DescribeStackDriftDetectionStatus. Once the drift - detection operation has completed, use DescribeStackResourceDrifts to return - drift information about the stack and its resources. - - - Container for the necessary parameters to execute the DescribeStackDriftDetectionStatus service method. - - The response from the DescribeStackDriftDetectionStatus service method, as returned by CloudFormation. - REST API Reference for DescribeStackDriftDetectionStatus Operation - - - - Returns information about a stack drift detection operation. A stack drift detection - operation detects whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. A stack is considered to have drifted if one or - more of its resources have drifted. For more information on stack and resource drift, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift - returns a StackDriftDetectionId you can use to monitor the progress of - the operation using DescribeStackDriftDetectionStatus. Once the drift - detection operation has completed, use DescribeStackResourceDrifts to return - drift information about the stack and its resources. - - - Container for the necessary parameters to execute the DescribeStackDriftDetectionStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackDriftDetectionStatus service method, as returned by CloudFormation. - REST API Reference for DescribeStackDriftDetectionStatus Operation - - - - Returns all stack related events for a specified stack in reverse chronological order. - For more information about a stack's event history, go to Stacks - in the AWS CloudFormation User Guide. - - - - You can list events for stacks that have failed to create or have been deleted by - specifying the unique stack identifier (stack ID). - - - - Container for the necessary parameters to execute the DescribeStackEvents service method. - - The response from the DescribeStackEvents service method, as returned by CloudFormation. - REST API Reference for DescribeStackEvents Operation - - - - Returns all stack related events for a specified stack in reverse chronological order. - For more information about a stack's event history, go to Stacks - in the AWS CloudFormation User Guide. - - - - You can list events for stacks that have failed to create or have been deleted by - specifying the unique stack identifier (stack ID). - - - - Container for the necessary parameters to execute the DescribeStackEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackEvents service method, as returned by CloudFormation. - REST API Reference for DescribeStackEvents Operation - - - - Returns the stack instance that's associated with the specified stack set, AWS account, - and Region. - - - - For a list of stack instances that are associated with a specific stack set, use ListStackInstances. - - - Container for the necessary parameters to execute the DescribeStackInstance service method. - - The response from the DescribeStackInstance service method, as returned by CloudFormation. - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackInstance Operation - - - - Returns the stack instance that's associated with the specified stack set, AWS account, - and Region. - - - - For a list of stack instances that are associated with a specific stack set, use ListStackInstances. - - - Container for the necessary parameters to execute the DescribeStackInstance service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackInstance service method, as returned by CloudFormation. - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackInstance Operation - - - - Returns a description of the specified resource in the specified stack. - - - - For deleted stacks, DescribeStackResource returns resource information for up to 90 - days after the stack has been deleted. - - - Container for the necessary parameters to execute the DescribeStackResource service method. - - The response from the DescribeStackResource service method, as returned by CloudFormation. - REST API Reference for DescribeStackResource Operation - - - - Returns a description of the specified resource in the specified stack. - - - - For deleted stacks, DescribeStackResource returns resource information for up to 90 - days after the stack has been deleted. - - - Container for the necessary parameters to execute the DescribeStackResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResource service method, as returned by CloudFormation. - REST API Reference for DescribeStackResource Operation - - - - Returns drift information for the resources that have been checked for drift in the - specified stack. This includes actual and expected configuration values for resources - where AWS CloudFormation detects configuration drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all supported resources for a given stack. - - - Container for the necessary parameters to execute the DescribeStackResourceDrifts service method. - - The response from the DescribeStackResourceDrifts service method, as returned by CloudFormation. - REST API Reference for DescribeStackResourceDrifts Operation - - - - Returns drift information for the resources that have been checked for drift in the - specified stack. This includes actual and expected configuration values for resources - where AWS CloudFormation detects configuration drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all supported resources for a given stack. - - - Container for the necessary parameters to execute the DescribeStackResourceDrifts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResourceDrifts service method, as returned by CloudFormation. - REST API Reference for DescribeStackResourceDrifts Operation - - - - Returns AWS resource descriptions for running and deleted stacks. If StackName - is specified, all the associated resources that are part of the stack are returned. - If PhysicalResourceId is specified, the associated resources of the stack - that the resource belongs to are returned. - - - - Only the first 100 resources will be returned. If your stack has more resources than - this, you should use ListStackResources instead. - - - - For deleted stacks, DescribeStackResources returns resource information - for up to 90 days after the stack has been deleted. - - - - You must specify either StackName or PhysicalResourceId, - but not both. In addition, you can specify LogicalResourceId to filter - the returned result. For more information about resources, the LogicalResourceId - and PhysicalResourceId, go to the AWS - CloudFormation User Guide. - - - - A ValidationError is returned if you specify both StackName - and PhysicalResourceId in the same request. - - - - Container for the necessary parameters to execute the DescribeStackResources service method. - - The response from the DescribeStackResources service method, as returned by CloudFormation. - REST API Reference for DescribeStackResources Operation - - - - Returns AWS resource descriptions for running and deleted stacks. If StackName - is specified, all the associated resources that are part of the stack are returned. - If PhysicalResourceId is specified, the associated resources of the stack - that the resource belongs to are returned. - - - - Only the first 100 resources will be returned. If your stack has more resources than - this, you should use ListStackResources instead. - - - - For deleted stacks, DescribeStackResources returns resource information - for up to 90 days after the stack has been deleted. - - - - You must specify either StackName or PhysicalResourceId, - but not both. In addition, you can specify LogicalResourceId to filter - the returned result. For more information about resources, the LogicalResourceId - and PhysicalResourceId, go to the AWS - CloudFormation User Guide. - - - - A ValidationError is returned if you specify both StackName - and PhysicalResourceId in the same request. - - - - Container for the necessary parameters to execute the DescribeStackResources service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResources service method, as returned by CloudFormation. - REST API Reference for DescribeStackResources Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - Container for the necessary parameters to execute the DescribeStacks service method. - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - Container for the necessary parameters to execute the DescribeStacks service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description of the specified stack set. - - Container for the necessary parameters to execute the DescribeStackSet service method. - - The response from the DescribeStackSet service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSet Operation - - - - Returns the description of the specified stack set. - - Container for the necessary parameters to execute the DescribeStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackSet service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSet Operation - - - - Returns the description of the specified stack set operation. - - Container for the necessary parameters to execute the DescribeStackSetOperation service method. - - The response from the DescribeStackSetOperation service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSetOperation Operation - - - - Returns the description of the specified stack set operation. - - Container for the necessary parameters to execute the DescribeStackSetOperation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackSetOperation service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSetOperation Operation - - - - Returns detailed information about an extension that has been registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - Container for the necessary parameters to execute the DescribeType service method. - - The response from the DescribeType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DescribeType Operation - - - - Returns detailed information about an extension that has been registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - Container for the necessary parameters to execute the DescribeType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DescribeType Operation - - - - Returns information about an extension's registration, including its current status - and type and version identifiers. - - - - When you initiate a registration request using RegisterType , - you can then use DescribeTypeRegistration to monitor the progress - of that registration request. - - - - Once the registration request has completed, use DescribeType - to return detailed information about an extension. - - - Container for the necessary parameters to execute the DescribeTypeRegistration service method. - - The response from the DescribeTypeRegistration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribeTypeRegistration Operation - - - - Returns information about an extension's registration, including its current status - and type and version identifiers. - - - - When you initiate a registration request using RegisterType , - you can then use DescribeTypeRegistration to monitor the progress - of that registration request. - - - - Once the registration request has completed, use DescribeType - to return detailed information about an extension. - - - Container for the necessary parameters to execute the DescribeTypeRegistration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeTypeRegistration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribeTypeRegistration Operation - - - - Detects whether a stack's actual configuration differs, or has drifted, from - it's expected configuration, as defined in the stack template and any values specified - as template parameters. For each resource in the stack that supports drift detection, - AWS CloudFormation compares the actual configuration of the resource with its expected - template configuration. Only resource properties explicitly defined in the stack template - are checked for drift. A stack is considered to have drifted if one or more of its - resources differ from their expected template configurations. For more information, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to detect drift on all supported resources for a - given stack, or DetectStackResourceDrift to detect drift on individual resources. - - - - For a list of stack resources that currently support drift detection, see Resources - that Support Drift Detection. - - - - DetectStackDrift can take up to several minutes, depending on the number - of resources contained within the stack. Use DescribeStackDriftDetectionStatus - to monitor the progress of a detect stack drift operation. Once the drift detection - operation has completed, use DescribeStackResourceDrifts to return drift information - about the stack and its resources. - - - - When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested - stacks belonging to that stack. Perform DetectStackDrift directly on - the nested stack itself. - - - Container for the necessary parameters to execute the DetectStackDrift service method. - - The response from the DetectStackDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackDrift Operation - - - - Detects whether a stack's actual configuration differs, or has drifted, from - it's expected configuration, as defined in the stack template and any values specified - as template parameters. For each resource in the stack that supports drift detection, - AWS CloudFormation compares the actual configuration of the resource with its expected - template configuration. Only resource properties explicitly defined in the stack template - are checked for drift. A stack is considered to have drifted if one or more of its - resources differ from their expected template configurations. For more information, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to detect drift on all supported resources for a - given stack, or DetectStackResourceDrift to detect drift on individual resources. - - - - For a list of stack resources that currently support drift detection, see Resources - that Support Drift Detection. - - - - DetectStackDrift can take up to several minutes, depending on the number - of resources contained within the stack. Use DescribeStackDriftDetectionStatus - to monitor the progress of a detect stack drift operation. Once the drift detection - operation has completed, use DescribeStackResourceDrifts to return drift information - about the stack and its resources. - - - - When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested - stacks belonging to that stack. Perform DetectStackDrift directly on - the nested stack itself. - - - Container for the necessary parameters to execute the DetectStackDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackDrift Operation - - - - Returns information about whether a resource's actual configuration differs, or has - drifted, from it's expected configuration, as defined in the stack template - and any values specified as template parameters. This information includes actual - and expected property values for resources in which AWS CloudFormation detects drift. - Only resource properties explicitly defined in the stack template are checked for - drift. For more information about stack and resource drift, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackResourceDrift to detect drift on individual resources, - or DetectStackDrift to detect drift on all resources in a given stack that - support drift detection. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - Container for the necessary parameters to execute the DetectStackResourceDrift service method. - - The response from the DetectStackResourceDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackResourceDrift Operation - - - - Returns information about whether a resource's actual configuration differs, or has - drifted, from it's expected configuration, as defined in the stack template - and any values specified as template parameters. This information includes actual - and expected property values for resources in which AWS CloudFormation detects drift. - Only resource properties explicitly defined in the stack template are checked for - drift. For more information about stack and resource drift, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackResourceDrift to detect drift on individual resources, - or DetectStackDrift to detect drift on all resources in a given stack that - support drift detection. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - Container for the necessary parameters to execute the DetectStackResourceDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackResourceDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackResourceDrift Operation - - - - Detect drift on a stack set. When CloudFormation performs drift detection on a stack - set, it performs drift detection on the stack associated with each stack instance - in the stack set. For more information, see How - CloudFormation Performs Drift Detection on a Stack Set. - - - - DetectStackSetDrift returns the OperationId of the stack - set drift detection operation. Use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. The drift detection - operation may take some time, depending on the number of stack instances included - in the stack set, as well as the number of resources included in each stack. - - - - Once the operation has completed, use the following actions to return drift information: - -
  • - - Use DescribeStackSet to return detailed information about the - stack set, including detailed information about the last completed drift operation - performed on the stack set. (Information about drift operations that are in progress - is not included.) - -
  • - - Use ListStackInstances to return a list of stack instances belonging - to the stack set, including the drift status and last drift time checked of each instance. - -
  • - - Use DescribeStackInstance to return detailed information about - a specific stack instance, including its drift status and last drift time checked. - -
- - For more information on performing a drift detection operation on a stack set, see - Detecting - Unmanaged Changes in Stack Sets. - - - - You can only run a single drift detection operation on a given stack set at one time. - - - - - To stop a drift detection stack set operation, use StopStackSetOperation - . - - - Container for the necessary parameters to execute the DetectStackSetDrift service method. - - The response from the DetectStackSetDrift service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - REST API Reference for DetectStackSetDrift Operation - - - - Detect drift on a stack set. When CloudFormation performs drift detection on a stack - set, it performs drift detection on the stack associated with each stack instance - in the stack set. For more information, see How - CloudFormation Performs Drift Detection on a Stack Set. - - - - DetectStackSetDrift returns the OperationId of the stack - set drift detection operation. Use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. The drift detection - operation may take some time, depending on the number of stack instances included - in the stack set, as well as the number of resources included in each stack. - - - - Once the operation has completed, use the following actions to return drift information: - -
  • - - Use DescribeStackSet to return detailed information about the - stack set, including detailed information about the last completed drift operation - performed on the stack set. (Information about drift operations that are in progress - is not included.) - -
  • - - Use ListStackInstances to return a list of stack instances belonging - to the stack set, including the drift status and last drift time checked of each instance. - -
  • - - Use DescribeStackInstance to return detailed information about - a specific stack instance, including its drift status and last drift time checked. - -
- - For more information on performing a drift detection operation on a stack set, see - Detecting - Unmanaged Changes in Stack Sets. - - - - You can only run a single drift detection operation on a given stack set at one time. - - - - - To stop a drift detection stack set operation, use StopStackSetOperation - . - - - Container for the necessary parameters to execute the DetectStackSetDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackSetDrift service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - REST API Reference for DetectStackSetDrift Operation - - - - Returns the estimated monthly cost of a template. The return value is an AWS Simple - Monthly Calculator URL with a query string that describes the resources required to - run the template. - - Container for the necessary parameters to execute the EstimateTemplateCost service method. - - The response from the EstimateTemplateCost service method, as returned by CloudFormation. - REST API Reference for EstimateTemplateCost Operation - - - - Returns the estimated monthly cost of a template. The return value is an AWS Simple - Monthly Calculator URL with a query string that describes the resources required to - run the template. - - Container for the necessary parameters to execute the EstimateTemplateCost service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the EstimateTemplateCost service method, as returned by CloudFormation. - REST API Reference for EstimateTemplateCost Operation - - - - Updates a stack using the input information that was provided when the specified change - set was created. After the call successfully completes, AWS CloudFormation starts - updating the stack. Use the DescribeStacks action to view the status of the - update. - - - - When you execute a change set, AWS CloudFormation deletes all other change sets associated - with the stack because they aren't valid for the updated stack. - - - - If a stack policy is associated with the stack, AWS CloudFormation enforces the policy - during the update. You can't specify a temporary stack policy that overrides the current - policy. - - - - To create a change set for the entire stack hierachy, IncludeNestedStacks - must have been set to True. - - - Container for the necessary parameters to execute the ExecuteChangeSet service method. - - The response from the ExecuteChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - - A client request token already exists. - - REST API Reference for ExecuteChangeSet Operation - - - - Updates a stack using the input information that was provided when the specified change - set was created. After the call successfully completes, AWS CloudFormation starts - updating the stack. Use the DescribeStacks action to view the status of the - update. - - - - When you execute a change set, AWS CloudFormation deletes all other change sets associated - with the stack because they aren't valid for the updated stack. - - - - If a stack policy is associated with the stack, AWS CloudFormation enforces the policy - during the update. You can't specify a temporary stack policy that overrides the current - policy. - - - - To create a change set for the entire stack hierachy, IncludeNestedStacks - must have been set to True. - - - Container for the necessary parameters to execute the ExecuteChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ExecuteChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - - A client request token already exists. - - REST API Reference for ExecuteChangeSet Operation - - - - Returns the stack policy for a specified stack. If a stack doesn't have a policy, - a null value is returned. - - Container for the necessary parameters to execute the GetStackPolicy service method. - - The response from the GetStackPolicy service method, as returned by CloudFormation. - REST API Reference for GetStackPolicy Operation - - - - Returns the stack policy for a specified stack. If a stack doesn't have a policy, - a null value is returned. - - Container for the necessary parameters to execute the GetStackPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetStackPolicy service method, as returned by CloudFormation. - REST API Reference for GetStackPolicy Operation - - - - Returns the template body for a specified stack. You can get the template for running - or deleted stacks. - - - - For deleted stacks, GetTemplate returns the template for up to 90 days after the stack - has been deleted. - - - - If the template does not exist, a ValidationError is returned. - - - - Container for the necessary parameters to execute the GetTemplate service method. - - The response from the GetTemplate service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for GetTemplate Operation - - - - Returns the template body for a specified stack. You can get the template for running - or deleted stacks. - - - - For deleted stacks, GetTemplate returns the template for up to 90 days after the stack - has been deleted. - - - - If the template does not exist, a ValidationError is returned. - - - - Container for the necessary parameters to execute the GetTemplate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetTemplate service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for GetTemplate Operation - - - - Returns information about a new or existing template. The GetTemplateSummary - action is useful for viewing parameter information, such as default parameter values - and parameter types, before you create or update a stack or stack set. - - - - You can use the GetTemplateSummary action when you submit a template, - or you can get template information for a stack set, or a running or deleted stack. - - - - For deleted stacks, GetTemplateSummary returns the template information - for up to 90 days after the stack has been deleted. If the template does not exist, - a ValidationError is returned. - - - Container for the necessary parameters to execute the GetTemplateSummary service method. - - The response from the GetTemplateSummary service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for GetTemplateSummary Operation - - - - Returns information about a new or existing template. The GetTemplateSummary - action is useful for viewing parameter information, such as default parameter values - and parameter types, before you create or update a stack or stack set. - - - - You can use the GetTemplateSummary action when you submit a template, - or you can get template information for a stack set, or a running or deleted stack. - - - - For deleted stacks, GetTemplateSummary returns the template information - for up to 90 days after the stack has been deleted. If the template does not exist, - a ValidationError is returned. - - - Container for the necessary parameters to execute the GetTemplateSummary service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetTemplateSummary service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for GetTemplateSummary Operation - - - - Returns the ID and status of each active change set for a stack. For example, AWS - CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - CREATE_PENDING state. - - Container for the necessary parameters to execute the ListChangeSets service method. - - The response from the ListChangeSets service method, as returned by CloudFormation. - REST API Reference for ListChangeSets Operation - - - - Returns the ID and status of each active change set for a stack. For example, AWS - CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - CREATE_PENDING state. - - Container for the necessary parameters to execute the ListChangeSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListChangeSets service method, as returned by CloudFormation. - REST API Reference for ListChangeSets Operation - - - - Lists all exported output values in the account and Region in which you call this - action. Use this action to see the exported output values that you can import into - other stacks. To import values, use the - Fn::ImportValue function. - - - - For more information, see - AWS CloudFormation Export Stack Output Values. - - - Container for the necessary parameters to execute the ListExports service method. - - The response from the ListExports service method, as returned by CloudFormation. - REST API Reference for ListExports Operation - - - - Lists all exported output values in the account and Region in which you call this - action. Use this action to see the exported output values that you can import into - other stacks. To import values, use the - Fn::ImportValue function. - - - - For more information, see - AWS CloudFormation Export Stack Output Values. - - - Container for the necessary parameters to execute the ListExports service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListExports service method, as returned by CloudFormation. - REST API Reference for ListExports Operation - - - - Lists all stacks that are importing an exported output value. To modify or remove - an exported output value, first use this action to see which stacks are using it. - To see the exported output values in your account, see ListExports. - - - - For more information about importing an exported output value, see the - Fn::ImportValue function. - - - Container for the necessary parameters to execute the ListImports service method. - - The response from the ListImports service method, as returned by CloudFormation. - REST API Reference for ListImports Operation - - - - Lists all stacks that are importing an exported output value. To modify or remove - an exported output value, first use this action to see which stacks are using it. - To see the exported output values in your account, see ListExports. - - - - For more information about importing an exported output value, see the - Fn::ImportValue function. - - - Container for the necessary parameters to execute the ListImports service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListImports service method, as returned by CloudFormation. - REST API Reference for ListImports Operation - - - - Returns summary information about stack instances that are associated with the specified - stack set. You can filter for stack instances that are associated with a specific - AWS account name or Region, or that have a specific status. - - Container for the necessary parameters to execute the ListStackInstances service method. - - The response from the ListStackInstances service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackInstances Operation - - - - Returns summary information about stack instances that are associated with the specified - stack set. You can filter for stack instances that are associated with a specific - AWS account name or Region, or that have a specific status. - - Container for the necessary parameters to execute the ListStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackInstances service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackInstances Operation - - - - Returns descriptions of all resources of the specified stack. - - - - For deleted stacks, ListStackResources returns resource information for up to 90 days - after the stack has been deleted. - - - Container for the necessary parameters to execute the ListStackResources service method. - - The response from the ListStackResources service method, as returned by CloudFormation. - REST API Reference for ListStackResources Operation - - - - Returns descriptions of all resources of the specified stack. - - - - For deleted stacks, ListStackResources returns resource information for up to 90 days - after the stack has been deleted. - - - Container for the necessary parameters to execute the ListStackResources service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackResources service method, as returned by CloudFormation. - REST API Reference for ListStackResources Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - Container for the necessary parameters to execute the ListStacks service method. - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - Container for the necessary parameters to execute the ListStacks service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns summary information about the results of a stack set operation. - - Container for the necessary parameters to execute the ListStackSetOperationResults service method. - - The response from the ListStackSetOperationResults service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperationResults Operation - - - - Returns summary information about the results of a stack set operation. - - Container for the necessary parameters to execute the ListStackSetOperationResults service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSetOperationResults service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperationResults Operation - - - - Returns summary information about operations performed on a stack set. - - Container for the necessary parameters to execute the ListStackSetOperations service method. - - The response from the ListStackSetOperations service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperations Operation - - - - Returns summary information about operations performed on a stack set. - - Container for the necessary parameters to execute the ListStackSetOperations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSetOperations service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperations Operation - - - - Returns summary information about stack sets that are associated with the user. - -
  • - - [Self-managed permissions] If you set the CallAs parameter to SELF - while signed in to your AWS account, ListStackSets returns all self-managed - stack sets in your AWS account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to SELF - while signed in to the organization's management account, ListStackSets - returns all stack sets in the management account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN - while signed in to your member account, ListStackSets returns all stack - sets with service-managed permissions in the management account. - -
- - Container for the necessary parameters to execute the ListStackSets service method. - - The response from the ListStackSets service method, as returned by CloudFormation. - REST API Reference for ListStackSets Operation - - - - Returns summary information about stack sets that are associated with the user. - -
  • - - [Self-managed permissions] If you set the CallAs parameter to SELF - while signed in to your AWS account, ListStackSets returns all self-managed - stack sets in your AWS account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to SELF - while signed in to the organization's management account, ListStackSets - returns all stack sets in the management account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN - while signed in to your member account, ListStackSets returns all stack - sets with service-managed permissions in the management account. - -
- - Container for the necessary parameters to execute the ListStackSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSets service method, as returned by CloudFormation. - REST API Reference for ListStackSets Operation - - - - Returns a list of registration tokens for the specified extension(s). - - Container for the necessary parameters to execute the ListTypeRegistrations service method. - - The response from the ListTypeRegistrations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeRegistrations Operation - - - - Returns a list of registration tokens for the specified extension(s). - - Container for the necessary parameters to execute the ListTypeRegistrations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypeRegistrations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeRegistrations Operation - - - - Returns summary information about extension that have been registered with CloudFormation. - - Container for the necessary parameters to execute the ListTypes service method. - - The response from the ListTypes service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypes Operation - - - - Returns summary information about extension that have been registered with CloudFormation. - - Container for the necessary parameters to execute the ListTypes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypes service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypes Operation - - - - Returns summary information about the versions of an extension. - - Container for the necessary parameters to execute the ListTypeVersions service method. - - The response from the ListTypeVersions service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeVersions Operation - - - - Returns summary information about the versions of an extension. - - Container for the necessary parameters to execute the ListTypeVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypeVersions service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeVersions Operation - - - - Publishes the specified extension to the CloudFormation registry as a public extension - in this region. Public extensions are available for use by all CloudFormation users. - For more information on publishing extensions, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - To publish an extension, you must be registered as a publisher with CloudFormation. - For more information, see RegisterPublisher. - - - Container for the necessary parameters to execute the PublishType service method. - - The response from the PublishType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for PublishType Operation - - - - Publishes the specified extension to the CloudFormation registry as a public extension - in this region. Public extensions are available for use by all CloudFormation users. - For more information on publishing extensions, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - To publish an extension, you must be registered as a publisher with CloudFormation. - For more information, see RegisterPublisher. - - - Container for the necessary parameters to execute the PublishType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PublishType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for PublishType Operation - - - - Reports progress of a resource handler to CloudFormation. - - - - Reserved for use by the CloudFormation - CLI. Do not use this API in your code. - - - Container for the necessary parameters to execute the RecordHandlerProgress service method. - - The response from the RecordHandlerProgress service method, as returned by CloudFormation. - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - REST API Reference for RecordHandlerProgress Operation - - - - Reports progress of a resource handler to CloudFormation. - - - - Reserved for use by the CloudFormation - CLI. Do not use this API in your code. - - - Container for the necessary parameters to execute the RecordHandlerProgress service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RecordHandlerProgress service method, as returned by CloudFormation. - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - REST API Reference for RecordHandlerProgress Operation - - - - Registers your account as a publisher of public extensions in the CloudFormation registry. - Public extensions are available for use by all CloudFormation users. This publisher - ID applies to your account in all AWS regions. - - - - For information on requirements for registering as a public extension publisher, see - Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the RegisterPublisher service method. - - The response from the RegisterPublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterPublisher Operation - - - - Registers your account as a publisher of public extensions in the CloudFormation registry. - Public extensions are available for use by all CloudFormation users. This publisher - ID applies to your account in all AWS regions. - - - - For information on requirements for registering as a public extension publisher, see - Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the RegisterPublisher service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterPublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterPublisher Operation - - - - Registers an extension with the CloudFormation service. Registering an extension makes - it available for use in CloudFormation templates in your AWS account, and includes: - -
  • - - Validating the extension schema - -
  • - - Determining which handlers, if any, have been specified for the extension - -
  • - - Making the extension available for use in your account - -
- - For more information on how to develop extensions and ready them for registeration, - see Creating - Resource Providers in the CloudFormation CLI User Guide. - - - - You can have a maximum of 50 resource extension versions registered at a time. This - maximum is per account and per region. Use DeregisterType - to deregister specific extension versions if necessary. - - - - Once you have initiated a registration request using RegisterType , - you can use DescribeTypeRegistration to monitor the progress - of the registration request. - - - - Once you have registered a private extension in your account and region, use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the RegisterType service method. - - The response from the RegisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterType Operation - - - - Registers an extension with the CloudFormation service. Registering an extension makes - it available for use in CloudFormation templates in your AWS account, and includes: - -
  • - - Validating the extension schema - -
  • - - Determining which handlers, if any, have been specified for the extension - -
  • - - Making the extension available for use in your account - -
- - For more information on how to develop extensions and ready them for registeration, - see Creating - Resource Providers in the CloudFormation CLI User Guide. - - - - You can have a maximum of 50 resource extension versions registered at a time. This - maximum is per account and per region. Use DeregisterType - to deregister specific extension versions if necessary. - - - - Once you have initiated a registration request using RegisterType , - you can use DescribeTypeRegistration to monitor the progress - of the registration request. - - - - Once you have registered a private extension in your account and region, use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the RegisterType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterType Operation - - - - Sets a stack policy for a specified stack. - - Container for the necessary parameters to execute the SetStackPolicy service method. - - The response from the SetStackPolicy service method, as returned by CloudFormation. - REST API Reference for SetStackPolicy Operation - - - - Sets a stack policy for a specified stack. - - Container for the necessary parameters to execute the SetStackPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetStackPolicy service method, as returned by CloudFormation. - REST API Reference for SetStackPolicy Operation - - - - Specifies the configuration data for a registered CloudFormation extension, in the - given account and region. - - - - To view the current configuration data for an extension, refer to the ConfigurationSchema - element of DescribeType. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - It is strongly recommended that you use dynamic references to restrict sensitive configuration - definitions, such as third-party credentials. For more details on dynamic references, - see Using dynamic references to specify template - values in the AWS CloudFormation User Guide. - - - - Container for the necessary parameters to execute the SetTypeConfiguration service method. - - The response from the SetTypeConfiguration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeConfiguration Operation - - - - Specifies the configuration data for a registered CloudFormation extension, in the - given account and region. - - - - To view the current configuration data for an extension, refer to the ConfigurationSchema - element of DescribeType. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - It is strongly recommended that you use dynamic references to restrict sensitive configuration - definitions, such as third-party credentials. For more details on dynamic references, - see Using dynamic references to specify template - values in the AWS CloudFormation User Guide. - - - - Container for the necessary parameters to execute the SetTypeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetTypeConfiguration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeConfiguration Operation - - - - Specify the default version of an extension. The default version of an extension will - be used in CloudFormation operations. - - Container for the necessary parameters to execute the SetTypeDefaultVersion service method. - - The response from the SetTypeDefaultVersion service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeDefaultVersion Operation - - - - Specify the default version of an extension. The default version of an extension will - be used in CloudFormation operations. - - Container for the necessary parameters to execute the SetTypeDefaultVersion service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetTypeDefaultVersion service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeDefaultVersion Operation - - - - Sends a signal to the specified resource with a success or failure status. You can - use the SignalResource API in conjunction with a creation policy or update policy. - AWS CloudFormation doesn't proceed with a stack creation or update until resources - receive the required number of signals or the timeout period is exceeded. The SignalResource - API is useful in cases where you want to send signals from anywhere other than an - Amazon EC2 instance. - - Container for the necessary parameters to execute the SignalResource service method. - - The response from the SignalResource service method, as returned by CloudFormation. - REST API Reference for SignalResource Operation - - - - Sends a signal to the specified resource with a success or failure status. You can - use the SignalResource API in conjunction with a creation policy or update policy. - AWS CloudFormation doesn't proceed with a stack creation or update until resources - receive the required number of signals or the timeout period is exceeded. The SignalResource - API is useful in cases where you want to send signals from anywhere other than an - Amazon EC2 instance. - - Container for the necessary parameters to execute the SignalResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SignalResource service method, as returned by CloudFormation. - REST API Reference for SignalResource Operation - - - - Stops an in-progress operation on a stack set and its associated stack instances. - - Container for the necessary parameters to execute the StopStackSetOperation service method. - - The response from the StopStackSetOperation service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for StopStackSetOperation Operation - - - - Stops an in-progress operation on a stack set and its associated stack instances. - - Container for the necessary parameters to execute the StopStackSetOperation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopStackSetOperation service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for StopStackSetOperation Operation - - - - Tests a registered extension to make sure it meets all necessary requirements for - being published in the CloudFormation registry. - -
  • - - For resource types, this includes passing all contracts tests defined for the type. - -
  • - - For modules, this includes determining if the module's model meets all necessary requirements. - -
- - For more information, see Testing - your public extension prior to publishing in the CloudFormation CLI User Guide. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in your account and region for testing. - - - - To perform testing, CloudFormation assumes the execution role specified when the test - was registered. For more information, see RegisterType. - - - - Once you've initiated testing on an extension using TestType, you can - use DescribeType - to monitor the current test status and test status description for the extension. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the TestType service method. - - The response from the TestType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for TestType Operation - - - - Tests a registered extension to make sure it meets all necessary requirements for - being published in the CloudFormation registry. - -
  • - - For resource types, this includes passing all contracts tests defined for the type. - -
  • - - For modules, this includes determining if the module's model meets all necessary requirements. - -
- - For more information, see Testing - your public extension prior to publishing in the CloudFormation CLI User Guide. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in your account and region for testing. - - - - To perform testing, CloudFormation assumes the execution role specified when the test - was registered. For more information, see RegisterType. - - - - Once you've initiated testing on an extension using TestType, you can - use DescribeType - to monitor the current test status and test status description for the extension. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the TestType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TestType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for TestType Operation - - - - Updates a stack as specified in the template. After the call completes successfully, - the stack update starts. You can check the status of the stack via the DescribeStacks - action. - - - - To get a copy of the template for an existing stack, you can use the GetTemplate - action. - - - - For more information about creating an update template, updating a stack, and monitoring - the progress of the update, see Updating - a Stack. - - - Container for the necessary parameters to execute the UpdateStack service method. - - The response from the UpdateStack service method, as returned by CloudFormation. - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - A client request token already exists. - - REST API Reference for UpdateStack Operation - - - - Updates a stack as specified in the template. After the call completes successfully, - the stack update starts. You can check the status of the stack via the DescribeStacks - action. - - - - To get a copy of the template for an existing stack, you can use the GetTemplate - action. - - - - For more information about creating an update template, updating a stack, and monitoring - the progress of the update, see Updating - a Stack. - - - Container for the necessary parameters to execute the UpdateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStack service method, as returned by CloudFormation. - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - A client request token already exists. - - REST API Reference for UpdateStack Operation - - - - Updates the parameter values for stack instances for the specified accounts, within - the specified Regions. A stack instance refers to a stack in a specific account and - Region. - - - - You can only update stack instances in Regions and accounts where they already exist; - to create additional stack instances, use CreateStackInstances. - - - - - During stack set updates, any parameters overridden for a stack instance are not updated, - but retain their overridden value. - - - - You can only update the parameter values that are specified in the stack set; - to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. If you add a parameter to a template, before you - can override the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - Container for the necessary parameters to execute the UpdateStackInstances service method. - - The response from the UpdateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackInstances Operation - - - - Updates the parameter values for stack instances for the specified accounts, within - the specified Regions. A stack instance refers to a stack in a specific account and - Region. - - - - You can only update stack instances in Regions and accounts where they already exist; - to create additional stack instances, use CreateStackInstances. - - - - - During stack set updates, any parameters overridden for a stack instance are not updated, - but retain their overridden value. - - - - You can only update the parameter values that are specified in the stack set; - to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. If you add a parameter to a template, before you - can override the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - Container for the necessary parameters to execute the UpdateStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackInstances Operation - - - - Updates the stack set, and associated stack instances in the specified accounts and - Regions. - - - - Even if the stack set operation created by updating the stack set fails (completely - or partially, below or above a specified failure tolerance), the stack set is updated - with your changes. Subsequent CreateStackInstances calls on the specified stack - set use the updated stack set. - - - Container for the necessary parameters to execute the UpdateStackSet service method. - - The response from the UpdateStackSet service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackSet Operation - - - - Updates the stack set, and associated stack instances in the specified accounts and - Regions. - - - - Even if the stack set operation created by updating the stack set fails (completely - or partially, below or above a specified failure tolerance), the stack set is updated - with your changes. Subsequent CreateStackInstances calls on the specified stack - set use the updated stack set. - - - Container for the necessary parameters to execute the UpdateStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStackSet service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackSet Operation - - - - Updates termination protection for the specified stack. If a user attempts to delete - a stack with termination protection enabled, the operation fails and the stack remains - unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - Container for the necessary parameters to execute the UpdateTerminationProtection service method. - - The response from the UpdateTerminationProtection service method, as returned by CloudFormation. - REST API Reference for UpdateTerminationProtection Operation - - - - Updates termination protection for the specified stack. If a user attempts to delete - a stack with termination protection enabled, the operation fails and the stack remains - unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - Container for the necessary parameters to execute the UpdateTerminationProtection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateTerminationProtection service method, as returned by CloudFormation. - REST API Reference for UpdateTerminationProtection Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - Container for the necessary parameters to execute the ValidateTemplate service method. - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - Container for the necessary parameters to execute the ValidateTemplate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Interface for accessing CloudFormation - - AWS CloudFormation - - AWS CloudFormation allows you to create and manage AWS infrastructure deployments - predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, - such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification - Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly - scalable, cost-effective applications without creating or configuring the underlying - AWS infrastructure. - - - - With AWS CloudFormation, you declare all of your resources and dependencies in a template - file. The template defines a collection of resources as a single unit called a stack. - AWS CloudFormation creates and deletes all member resources of the stack together - and manages all dependencies between the resources for you. - - - - For more information about AWS CloudFormation, see the AWS - CloudFormation Product Page. - - - - Amazon CloudFormation makes use of other AWS products. If you need additional technical - information about a specific AWS product, you can find the product's technical documentation - at docs.aws.amazon.com. - - - - - - Paginators for the service - - - - - Activates a public third-party extension, making it available for use in stack templates. - For more information, see Using - public extensions in the CloudFormation User Guide. - - - - Once you have activated a public third-party extension in your account and region, - use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the ActivateType service method. - - The response from the ActivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for ActivateType Operation - - - - Activates a public third-party extension, making it available for use in stack templates. - For more information, see Using - public extensions in the CloudFormation User Guide. - - - - Once you have activated a public third-party extension in your account and region, - use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the ActivateType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ActivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for ActivateType Operation - - - - Returns configuration data for the specified CloudFormation extensions, from the CloudFormation - registry for the account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the BatchDescribeTypeConfigurations service method. - - The response from the BatchDescribeTypeConfigurations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension configuration cannot be found. - - REST API Reference for BatchDescribeTypeConfigurations Operation - - - - Returns configuration data for the specified CloudFormation extensions, from the CloudFormation - registry for the account and region. - - - - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the BatchDescribeTypeConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the BatchDescribeTypeConfigurations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension configuration cannot be found. - - REST API Reference for BatchDescribeTypeConfigurations Operation - - - - Cancels an update on the specified stack. If the call completes successfully, the - stack rolls back the update and reverts to the previous stack configuration. - - - - You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. - - - - Container for the necessary parameters to execute the CancelUpdateStack service method. - - The response from the CancelUpdateStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for CancelUpdateStack Operation - - - - Cancels an update on the specified stack. If the call completes successfully, the - stack rolls back the update and reverts to the previous stack configuration. - - - - You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. - - - - Container for the necessary parameters to execute the CancelUpdateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CancelUpdateStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for CancelUpdateStack Operation - - - - For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues - rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the - cause of the failure, you can manually - fix the error and continue the rollback. By continuing the rollback, you can return - your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - then try to update the stack again. - - - - A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation - cannot roll back all changes after a failed stack update. For example, you might have - a stack that is rolling back to an old database instance that was deleted outside - of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, - it assumes that the database instance still exists and attempts to roll back to it, - causing the update rollback to fail. - - - Container for the necessary parameters to execute the ContinueUpdateRollback service method. - - The response from the ContinueUpdateRollback service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for ContinueUpdateRollback Operation - - - - For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues - rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the - cause of the failure, you can manually - fix the error and continue the rollback. By continuing the rollback, you can return - your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - then try to update the stack again. - - - - A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation - cannot roll back all changes after a failed stack update. For example, you might have - a stack that is rolling back to an old database instance that was deleted outside - of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, - it assumes that the database instance still exists and attempts to roll back to it, - causing the update rollback to fail. - - - Container for the necessary parameters to execute the ContinueUpdateRollback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ContinueUpdateRollback service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for ContinueUpdateRollback Operation - - - - Creates a list of changes that will be applied to a stack so that you can review the - changes before executing them. You can create a change set for a stack that doesn't - exist or an existing stack. If you create a change set for a stack that doesn't exist, - the change set shows all of the resources that AWS CloudFormation will create. If - you create a change set for an existing stack, AWS CloudFormation compares the stack's - information with the information that you submit in the change set and lists the differences. - Use change sets to understand which resources AWS CloudFormation will create or change, - and how it will change resources in an existing stack, before you create or update - a stack. - - - - To create a change set for a stack that doesn't exist, for the ChangeSetType - parameter, specify CREATE. To create a change set for an existing stack, - specify UPDATE for the ChangeSetType parameter. To create - a change set for an import operation, specify IMPORT for the ChangeSetType - parameter. After the CreateChangeSet call successfully completes, AWS - CloudFormation starts creating the change set. To check the status of the change set - or to review it, use the DescribeChangeSet action. - - - - When you are satisfied with the changes the change set will make, execute the change - set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes - until you execute the change set. - - - - To create a change set for the entire stack hierachy, set IncludeNestedStacks - to True. - - - Container for the necessary parameters to execute the CreateChangeSet service method. - - The response from the CreateChangeSet service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - REST API Reference for CreateChangeSet Operation - - - - Creates a list of changes that will be applied to a stack so that you can review the - changes before executing them. You can create a change set for a stack that doesn't - exist or an existing stack. If you create a change set for a stack that doesn't exist, - the change set shows all of the resources that AWS CloudFormation will create. If - you create a change set for an existing stack, AWS CloudFormation compares the stack's - information with the information that you submit in the change set and lists the differences. - Use change sets to understand which resources AWS CloudFormation will create or change, - and how it will change resources in an existing stack, before you create or update - a stack. - - - - To create a change set for a stack that doesn't exist, for the ChangeSetType - parameter, specify CREATE. To create a change set for an existing stack, - specify UPDATE for the ChangeSetType parameter. To create - a change set for an import operation, specify IMPORT for the ChangeSetType - parameter. After the CreateChangeSet call successfully completes, AWS - CloudFormation starts creating the change set. To check the status of the change set - or to review it, use the DescribeChangeSet action. - - - - When you are satisfied with the changes the change set will make, execute the change - set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes - until you execute the change set. - - - - To create a change set for the entire stack hierachy, set IncludeNestedStacks - to True. - - - Container for the necessary parameters to execute the CreateChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateChangeSet service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - REST API Reference for CreateChangeSet Operation - - - - Creates a stack as specified in the template. After the call completes successfully, - the stack creation starts. You can check the status of the stack via the DescribeStacks - API. - - Container for the necessary parameters to execute the CreateStack service method. - - The response from the CreateStack service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - A client request token already exists. - - REST API Reference for CreateStack Operation - - - - Creates a stack as specified in the template. After the call completes successfully, - the stack creation starts. You can check the status of the stack via the DescribeStacks - API. - - Container for the necessary parameters to execute the CreateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStack service method, as returned by CloudFormation. - - The resource with the name requested already exists. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - A client request token already exists. - - REST API Reference for CreateStack Operation - - - - Creates stack instances for the specified accounts, within the specified Regions. - A stack instance refers to a stack in a specific account and Region. You must specify - at least one value for either Accounts or DeploymentTargets, - and you must specify at least one value for Regions. - - Container for the necessary parameters to execute the CreateStackInstances service method. - - The response from the CreateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for CreateStackInstances Operation - - - - Creates stack instances for the specified accounts, within the specified Regions. - A stack instance refers to a stack in a specific account and Region. You must specify - at least one value for either Accounts or DeploymentTargets, - and you must specify at least one value for Regions. - - Container for the necessary parameters to execute the CreateStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for CreateStackInstances Operation - - - - Creates a stack set. - - Container for the necessary parameters to execute the CreateStackSet service method. - - The response from the CreateStackSet service method, as returned by CloudFormation. - - The specified resource exists, but has been changed. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified name is already in use. - - REST API Reference for CreateStackSet Operation - - - - Creates a stack set. - - Container for the necessary parameters to execute the CreateStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateStackSet service method, as returned by CloudFormation. - - The specified resource exists, but has been changed. - - - The quota for the resource has already been reached. - - - - For information on resource and stack limitations, see Limits - in the AWS CloudFormation User Guide. - - - - The specified name is already in use. - - REST API Reference for CreateStackSet Operation - - - - Deactivates a public extension that was previously activated in this account and region. - - - - Once deactivated, an extension cannot be used in any CloudFormation operation. This - includes stack update operations where the stack template includes the extension, - even if no updates are being made to the extension. In addition, deactivated extensions - are not automatically updated if a new version of the extension is released. - - - Container for the necessary parameters to execute the DeactivateType service method. - - The response from the DeactivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeactivateType Operation - - - - Deactivates a public extension that was previously activated in this account and region. - - - - Once deactivated, an extension cannot be used in any CloudFormation operation. This - includes stack update operations where the stack template includes the extension, - even if no updates are being made to the extension. In addition, deactivated extensions - are not automatically updated if a new version of the extension is released. - - - Container for the necessary parameters to execute the DeactivateType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeactivateType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeactivateType Operation - - - - Deletes the specified change set. Deleting change sets ensures that no one executes - the wrong change set. - - - - If the call successfully completes, AWS CloudFormation successfully deleted the change - set. - - - - If IncludeNestedStacks specifies True during the creation - of the nested change set, then DeleteChangeSet will delete all change - sets that belong to the stacks hierarchy and will also delete all change sets for - nested stacks with the status of REVIEW_IN_PROGRESS. - - - Container for the necessary parameters to execute the DeleteChangeSet service method. - - The response from the DeleteChangeSet service method, as returned by CloudFormation. - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - REST API Reference for DeleteChangeSet Operation - - - - Deletes the specified change set. Deleting change sets ensures that no one executes - the wrong change set. - - - - If the call successfully completes, AWS CloudFormation successfully deleted the change - set. - - - - If IncludeNestedStacks specifies True during the creation - of the nested change set, then DeleteChangeSet will delete all change - sets that belong to the stacks hierarchy and will also delete all change sets for - nested stacks with the status of REVIEW_IN_PROGRESS. - - - Container for the necessary parameters to execute the DeleteChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteChangeSet service method, as returned by CloudFormation. - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - REST API Reference for DeleteChangeSet Operation - - - - Deletes a specified stack. Once the call completes successfully, stack deletion starts. - Deleted stacks do not show up in the DescribeStacks API if the deletion has - been completed successfully. - - Container for the necessary parameters to execute the DeleteStack service method. - - The response from the DeleteStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for DeleteStack Operation - - - - Deletes a specified stack. Once the call completes successfully, stack deletion starts. - Deleted stacks do not show up in the DescribeStacks API if the deletion has - been completed successfully. - - Container for the necessary parameters to execute the DeleteStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStack service method, as returned by CloudFormation. - - A client request token already exists. - - REST API Reference for DeleteStack Operation - - - - Deletes stack instances for the specified accounts, in the specified Regions. - - Container for the necessary parameters to execute the DeleteStackInstances service method. - - The response from the DeleteStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for DeleteStackInstances Operation - - - - Deletes stack instances for the specified accounts, in the specified Regions. - - Container for the necessary parameters to execute the DeleteStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for DeleteStackInstances Operation - - - - Deletes a stack set. Before you can delete a stack set, all of its member stack instances - must be deleted. For more information about how to do this, see DeleteStackInstances. - - Container for the necessary parameters to execute the DeleteStackSet service method. - - The response from the DeleteStackSet service method, as returned by CloudFormation. - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - You can't yet delete this stack set, because it still contains one or more stack instances. - Delete all stack instances from the stack set before deleting the stack set. - - REST API Reference for DeleteStackSet Operation - - - - Deletes a stack set. Before you can delete a stack set, all of its member stack instances - must be deleted. For more information about how to do this, see DeleteStackInstances. - - Container for the necessary parameters to execute the DeleteStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteStackSet service method, as returned by CloudFormation. - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - You can't yet delete this stack set, because it still contains one or more stack instances. - Delete all stack instances from the stack set before deleting the stack set. - - REST API Reference for DeleteStackSet Operation - - - - Marks an extension or extension version as DEPRECATED in the CloudFormation - registry, removing it from active use. Deprecated extensions or extension versions - cannot be used in CloudFormation operations. - - - - To deregister an entire extension, you must individually deregister all active versions - of that extension. If an extension has only a single active version, deregistering - that version results in the extension itself being deregistered and marked as deprecated - in the registry. - - - - You cannot deregister the default version of an extension if there are other active - version of that extension. If you do deregister the default version of an extension, - the textensionype itself is deregistered as well and marked as deprecated. - - - - To view the deprecation status of an extension or extension version, use DescribeType. - - - Container for the necessary parameters to execute the DeregisterType service method. - - The response from the DeregisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeregisterType Operation - - - - Marks an extension or extension version as DEPRECATED in the CloudFormation - registry, removing it from active use. Deprecated extensions or extension versions - cannot be used in CloudFormation operations. - - - - To deregister an entire extension, you must individually deregister all active versions - of that extension. If an extension has only a single active version, deregistering - that version results in the extension itself being deregistered and marked as deprecated - in the registry. - - - - You cannot deregister the default version of an extension if there are other active - version of that extension. If you do deregister the default version of an extension, - the textensionype itself is deregistered as well and marked as deprecated. - - - - To view the deprecation status of an extension or extension version, use DescribeType. - - - Container for the necessary parameters to execute the DeregisterType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeregisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DeregisterType Operation - - - - Retrieves your account's AWS CloudFormation limits, such as the maximum number of - stacks that you can create in your account. For more information about account limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeAccountLimits service method. - - The response from the DescribeAccountLimits service method, as returned by CloudFormation. - REST API Reference for DescribeAccountLimits Operation - - - - Retrieves your account's AWS CloudFormation limits, such as the maximum number of - stacks that you can create in your account. For more information about account limits, - see AWS - CloudFormation Limits in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeAccountLimits service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAccountLimits service method, as returned by CloudFormation. - REST API Reference for DescribeAccountLimits Operation - - - - Returns the inputs for the change set and a list of changes that AWS CloudFormation - will make if you execute the change set. For more information, see Updating - Stacks Using Change Sets in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeChangeSet service method. - - The response from the DescribeChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for DescribeChangeSet Operation - - - - Returns the inputs for the change set and a list of changes that AWS CloudFormation - will make if you execute the change set. For more information, see Updating - Stacks Using Change Sets in the AWS CloudFormation User Guide. - - Container for the necessary parameters to execute the DescribeChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for DescribeChangeSet Operation - - - - Returns information about a CloudFormation extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - For more information on registering as a publisher, see: - - - - Container for the necessary parameters to execute the DescribePublisher service method. - - The response from the DescribePublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribePublisher Operation - - - - Returns information about a CloudFormation extension publisher. - - - - If you do not supply a PublisherId, and you have registered as an extension - publisher, DescribePublisher returns information about your own publisher - account. - - - - For more information on registering as a publisher, see: - - - - Container for the necessary parameters to execute the DescribePublisher service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribePublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribePublisher Operation - - - - Returns information about a stack drift detection operation. A stack drift detection - operation detects whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. A stack is considered to have drifted if one or - more of its resources have drifted. For more information on stack and resource drift, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift - returns a StackDriftDetectionId you can use to monitor the progress of - the operation using DescribeStackDriftDetectionStatus. Once the drift - detection operation has completed, use DescribeStackResourceDrifts to return - drift information about the stack and its resources. - - - Container for the necessary parameters to execute the DescribeStackDriftDetectionStatus service method. - - The response from the DescribeStackDriftDetectionStatus service method, as returned by CloudFormation. - REST API Reference for DescribeStackDriftDetectionStatus Operation - - - - Returns information about a stack drift detection operation. A stack drift detection - operation detects whether a stack's actual configuration differs, or has drifted, - from it's expected configuration, as defined in the stack template and any values - specified as template parameters. A stack is considered to have drifted if one or - more of its resources have drifted. For more information on stack and resource drift, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift - returns a StackDriftDetectionId you can use to monitor the progress of - the operation using DescribeStackDriftDetectionStatus. Once the drift - detection operation has completed, use DescribeStackResourceDrifts to return - drift information about the stack and its resources. - - - Container for the necessary parameters to execute the DescribeStackDriftDetectionStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackDriftDetectionStatus service method, as returned by CloudFormation. - REST API Reference for DescribeStackDriftDetectionStatus Operation - - - - Returns all stack related events for a specified stack in reverse chronological order. - For more information about a stack's event history, go to Stacks - in the AWS CloudFormation User Guide. - - - - You can list events for stacks that have failed to create or have been deleted by - specifying the unique stack identifier (stack ID). - - - - Container for the necessary parameters to execute the DescribeStackEvents service method. - - The response from the DescribeStackEvents service method, as returned by CloudFormation. - REST API Reference for DescribeStackEvents Operation - - - - Returns all stack related events for a specified stack in reverse chronological order. - For more information about a stack's event history, go to Stacks - in the AWS CloudFormation User Guide. - - - - You can list events for stacks that have failed to create or have been deleted by - specifying the unique stack identifier (stack ID). - - - - Container for the necessary parameters to execute the DescribeStackEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackEvents service method, as returned by CloudFormation. - REST API Reference for DescribeStackEvents Operation - - - - Returns the stack instance that's associated with the specified stack set, AWS account, - and Region. - - - - For a list of stack instances that are associated with a specific stack set, use ListStackInstances. - - - Container for the necessary parameters to execute the DescribeStackInstance service method. - - The response from the DescribeStackInstance service method, as returned by CloudFormation. - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackInstance Operation - - - - Returns the stack instance that's associated with the specified stack set, AWS account, - and Region. - - - - For a list of stack instances that are associated with a specific stack set, use ListStackInstances. - - - Container for the necessary parameters to execute the DescribeStackInstance service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackInstance service method, as returned by CloudFormation. - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackInstance Operation - - - - Returns a description of the specified resource in the specified stack. - - - - For deleted stacks, DescribeStackResource returns resource information for up to 90 - days after the stack has been deleted. - - - Container for the necessary parameters to execute the DescribeStackResource service method. - - The response from the DescribeStackResource service method, as returned by CloudFormation. - REST API Reference for DescribeStackResource Operation - - - - Returns a description of the specified resource in the specified stack. - - - - For deleted stacks, DescribeStackResource returns resource information for up to 90 - days after the stack has been deleted. - - - Container for the necessary parameters to execute the DescribeStackResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResource service method, as returned by CloudFormation. - REST API Reference for DescribeStackResource Operation - - - - Returns drift information for the resources that have been checked for drift in the - specified stack. This includes actual and expected configuration values for resources - where AWS CloudFormation detects configuration drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all supported resources for a given stack. - - - Container for the necessary parameters to execute the DescribeStackResourceDrifts service method. - - The response from the DescribeStackResourceDrifts service method, as returned by CloudFormation. - REST API Reference for DescribeStackResourceDrifts Operation - - - - Returns drift information for the resources that have been checked for drift in the - specified stack. This includes actual and expected configuration values for resources - where AWS CloudFormation detects configuration drift. - - - - For a given stack, there will be one StackResourceDrift for each stack - resource that has been checked for drift. Resources that have not yet been checked - for drift are not included. Resources that do not currently support drift detection - are not checked, and so not included. For a list of resources that support drift detection, - see Resources - that Support Drift Detection. - - - - Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift - to detect drift on all supported resources for a given stack. - - - Container for the necessary parameters to execute the DescribeStackResourceDrifts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResourceDrifts service method, as returned by CloudFormation. - REST API Reference for DescribeStackResourceDrifts Operation - - - - Returns AWS resource descriptions for running and deleted stacks. If StackName - is specified, all the associated resources that are part of the stack are returned. - If PhysicalResourceId is specified, the associated resources of the stack - that the resource belongs to are returned. - - - - Only the first 100 resources will be returned. If your stack has more resources than - this, you should use ListStackResources instead. - - - - For deleted stacks, DescribeStackResources returns resource information - for up to 90 days after the stack has been deleted. - - - - You must specify either StackName or PhysicalResourceId, - but not both. In addition, you can specify LogicalResourceId to filter - the returned result. For more information about resources, the LogicalResourceId - and PhysicalResourceId, go to the AWS - CloudFormation User Guide. - - - - A ValidationError is returned if you specify both StackName - and PhysicalResourceId in the same request. - - - - Container for the necessary parameters to execute the DescribeStackResources service method. - - The response from the DescribeStackResources service method, as returned by CloudFormation. - REST API Reference for DescribeStackResources Operation - - - - Returns AWS resource descriptions for running and deleted stacks. If StackName - is specified, all the associated resources that are part of the stack are returned. - If PhysicalResourceId is specified, the associated resources of the stack - that the resource belongs to are returned. - - - - Only the first 100 resources will be returned. If your stack has more resources than - this, you should use ListStackResources instead. - - - - For deleted stacks, DescribeStackResources returns resource information - for up to 90 days after the stack has been deleted. - - - - You must specify either StackName or PhysicalResourceId, - but not both. In addition, you can specify LogicalResourceId to filter - the returned result. For more information about resources, the LogicalResourceId - and PhysicalResourceId, go to the AWS - CloudFormation User Guide. - - - - A ValidationError is returned if you specify both StackName - and PhysicalResourceId in the same request. - - - - Container for the necessary parameters to execute the DescribeStackResources service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackResources service method, as returned by CloudFormation. - REST API Reference for DescribeStackResources Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - Container for the necessary parameters to execute the DescribeStacks service method. - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description for the specified stack; if no stack name was specified, then - it returns the description for all the stacks created. - - - - If the stack does not exist, an AmazonCloudFormationException is returned. - - - - Container for the necessary parameters to execute the DescribeStacks service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStacks service method, as returned by CloudFormation. - REST API Reference for DescribeStacks Operation - - - - Returns the description of the specified stack set. - - Container for the necessary parameters to execute the DescribeStackSet service method. - - The response from the DescribeStackSet service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSet Operation - - - - Returns the description of the specified stack set. - - Container for the necessary parameters to execute the DescribeStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackSet service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSet Operation - - - - Returns the description of the specified stack set operation. - - Container for the necessary parameters to execute the DescribeStackSetOperation service method. - - The response from the DescribeStackSetOperation service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSetOperation Operation - - - - Returns the description of the specified stack set operation. - - Container for the necessary parameters to execute the DescribeStackSetOperation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeStackSetOperation service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for DescribeStackSetOperation Operation - - - - Returns detailed information about an extension that has been registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - Container for the necessary parameters to execute the DescribeType service method. - - The response from the DescribeType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DescribeType Operation - - - - Returns detailed information about an extension that has been registered. - - - - If you specify a VersionId, DescribeType returns information - about that specific extension version. Otherwise, it returns information about the - default extension version. - - - Container for the necessary parameters to execute the DescribeType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for DescribeType Operation - - - - Returns information about an extension's registration, including its current status - and type and version identifiers. - - - - When you initiate a registration request using RegisterType , - you can then use DescribeTypeRegistration to monitor the progress - of that registration request. - - - - Once the registration request has completed, use DescribeType - to return detailed information about an extension. - - - Container for the necessary parameters to execute the DescribeTypeRegistration service method. - - The response from the DescribeTypeRegistration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribeTypeRegistration Operation - - - - Returns information about an extension's registration, including its current status - and type and version identifiers. - - - - When you initiate a registration request using RegisterType , - you can then use DescribeTypeRegistration to monitor the progress - of that registration request. - - - - Once the registration request has completed, use DescribeType - to return detailed information about an extension. - - - Container for the necessary parameters to execute the DescribeTypeRegistration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeTypeRegistration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for DescribeTypeRegistration Operation - - - - Detects whether a stack's actual configuration differs, or has drifted, from - it's expected configuration, as defined in the stack template and any values specified - as template parameters. For each resource in the stack that supports drift detection, - AWS CloudFormation compares the actual configuration of the resource with its expected - template configuration. Only resource properties explicitly defined in the stack template - are checked for drift. A stack is considered to have drifted if one or more of its - resources differ from their expected template configurations. For more information, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to detect drift on all supported resources for a - given stack, or DetectStackResourceDrift to detect drift on individual resources. - - - - For a list of stack resources that currently support drift detection, see Resources - that Support Drift Detection. - - - - DetectStackDrift can take up to several minutes, depending on the number - of resources contained within the stack. Use DescribeStackDriftDetectionStatus - to monitor the progress of a detect stack drift operation. Once the drift detection - operation has completed, use DescribeStackResourceDrifts to return drift information - about the stack and its resources. - - - - When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested - stacks belonging to that stack. Perform DetectStackDrift directly on - the nested stack itself. - - - Container for the necessary parameters to execute the DetectStackDrift service method. - - The response from the DetectStackDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackDrift Operation - - - - Detects whether a stack's actual configuration differs, or has drifted, from - it's expected configuration, as defined in the stack template and any values specified - as template parameters. For each resource in the stack that supports drift detection, - AWS CloudFormation compares the actual configuration of the resource with its expected - template configuration. Only resource properties explicitly defined in the stack template - are checked for drift. A stack is considered to have drifted if one or more of its - resources differ from their expected template configurations. For more information, - see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackDrift to detect drift on all supported resources for a - given stack, or DetectStackResourceDrift to detect drift on individual resources. - - - - For a list of stack resources that currently support drift detection, see Resources - that Support Drift Detection. - - - - DetectStackDrift can take up to several minutes, depending on the number - of resources contained within the stack. Use DescribeStackDriftDetectionStatus - to monitor the progress of a detect stack drift operation. Once the drift detection - operation has completed, use DescribeStackResourceDrifts to return drift information - about the stack and its resources. - - - - When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested - stacks belonging to that stack. Perform DetectStackDrift directly on - the nested stack itself. - - - Container for the necessary parameters to execute the DetectStackDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackDrift Operation - - - - Returns information about whether a resource's actual configuration differs, or has - drifted, from it's expected configuration, as defined in the stack template - and any values specified as template parameters. This information includes actual - and expected property values for resources in which AWS CloudFormation detects drift. - Only resource properties explicitly defined in the stack template are checked for - drift. For more information about stack and resource drift, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackResourceDrift to detect drift on individual resources, - or DetectStackDrift to detect drift on all resources in a given stack that - support drift detection. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - Container for the necessary parameters to execute the DetectStackResourceDrift service method. - - The response from the DetectStackResourceDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackResourceDrift Operation - - - - Returns information about whether a resource's actual configuration differs, or has - drifted, from it's expected configuration, as defined in the stack template - and any values specified as template parameters. This information includes actual - and expected property values for resources in which AWS CloudFormation detects drift. - Only resource properties explicitly defined in the stack template are checked for - drift. For more information about stack and resource drift, see Detecting - Unregulated Configuration Changes to Stacks and Resources. - - - - Use DetectStackResourceDrift to detect drift on individual resources, - or DetectStackDrift to detect drift on all resources in a given stack that - support drift detection. - - - - Resources that do not currently support drift detection cannot be checked. For a list - of resources that support drift detection, see Resources - that Support Drift Detection. - - - Container for the necessary parameters to execute the DetectStackResourceDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackResourceDrift service method, as returned by CloudFormation. - REST API Reference for DetectStackResourceDrift Operation - - - - Detect drift on a stack set. When CloudFormation performs drift detection on a stack - set, it performs drift detection on the stack associated with each stack instance - in the stack set. For more information, see How - CloudFormation Performs Drift Detection on a Stack Set. - - - - DetectStackSetDrift returns the OperationId of the stack - set drift detection operation. Use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. The drift detection - operation may take some time, depending on the number of stack instances included - in the stack set, as well as the number of resources included in each stack. - - - - Once the operation has completed, use the following actions to return drift information: - -
  • - - Use DescribeStackSet to return detailed information about the - stack set, including detailed information about the last completed drift operation - performed on the stack set. (Information about drift operations that are in progress - is not included.) - -
  • - - Use ListStackInstances to return a list of stack instances belonging - to the stack set, including the drift status and last drift time checked of each instance. - -
  • - - Use DescribeStackInstance to return detailed information about - a specific stack instance, including its drift status and last drift time checked. - -
- - For more information on performing a drift detection operation on a stack set, see - Detecting - Unmanaged Changes in Stack Sets. - - - - You can only run a single drift detection operation on a given stack set at one time. - - - - - To stop a drift detection stack set operation, use StopStackSetOperation - . - - - Container for the necessary parameters to execute the DetectStackSetDrift service method. - - The response from the DetectStackSetDrift service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - REST API Reference for DetectStackSetDrift Operation - - - - Detect drift on a stack set. When CloudFormation performs drift detection on a stack - set, it performs drift detection on the stack associated with each stack instance - in the stack set. For more information, see How - CloudFormation Performs Drift Detection on a Stack Set. - - - - DetectStackSetDrift returns the OperationId of the stack - set drift detection operation. Use this operation id with DescribeStackSetOperation - to monitor the progress of the drift detection operation. The drift detection - operation may take some time, depending on the number of stack instances included - in the stack set, as well as the number of resources included in each stack. - - - - Once the operation has completed, use the following actions to return drift information: - -
  • - - Use DescribeStackSet to return detailed information about the - stack set, including detailed information about the last completed drift operation - performed on the stack set. (Information about drift operations that are in progress - is not included.) - -
  • - - Use ListStackInstances to return a list of stack instances belonging - to the stack set, including the drift status and last drift time checked of each instance. - -
  • - - Use DescribeStackInstance to return detailed information about - a specific stack instance, including its drift status and last drift time checked. - -
- - For more information on performing a drift detection operation on a stack set, see - Detecting - Unmanaged Changes in Stack Sets. - - - - You can only run a single drift detection operation on a given stack set at one time. - - - - - To stop a drift detection stack set operation, use StopStackSetOperation - . - - - Container for the necessary parameters to execute the DetectStackSetDrift service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DetectStackSetDrift service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack set doesn't exist. - - REST API Reference for DetectStackSetDrift Operation - - - - Returns the estimated monthly cost of a template. The return value is an AWS Simple - Monthly Calculator URL with a query string that describes the resources required to - run the template. - - Container for the necessary parameters to execute the EstimateTemplateCost service method. - - The response from the EstimateTemplateCost service method, as returned by CloudFormation. - REST API Reference for EstimateTemplateCost Operation - - - - Returns the estimated monthly cost of a template. The return value is an AWS Simple - Monthly Calculator URL with a query string that describes the resources required to - run the template. - - Container for the necessary parameters to execute the EstimateTemplateCost service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the EstimateTemplateCost service method, as returned by CloudFormation. - REST API Reference for EstimateTemplateCost Operation - - - - Updates a stack using the input information that was provided when the specified change - set was created. After the call successfully completes, AWS CloudFormation starts - updating the stack. Use the DescribeStacks action to view the status of the - update. - - - - When you execute a change set, AWS CloudFormation deletes all other change sets associated - with the stack because they aren't valid for the updated stack. - - - - If a stack policy is associated with the stack, AWS CloudFormation enforces the policy - during the update. You can't specify a temporary stack policy that overrides the current - policy. - - - - To create a change set for the entire stack hierachy, IncludeNestedStacks - must have been set to True. - - - Container for the necessary parameters to execute the ExecuteChangeSet service method. - - The response from the ExecuteChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - - A client request token already exists. - - REST API Reference for ExecuteChangeSet Operation - - - - Updates a stack using the input information that was provided when the specified change - set was created. After the call successfully completes, AWS CloudFormation starts - updating the stack. Use the DescribeStacks action to view the status of the - update. - - - - When you execute a change set, AWS CloudFormation deletes all other change sets associated - with the stack because they aren't valid for the updated stack. - - - - If a stack policy is associated with the stack, AWS CloudFormation enforces the policy - during the update. You can't specify a temporary stack policy that overrides the current - policy. - - - - To create a change set for the entire stack hierachy, IncludeNestedStacks - must have been set to True. - - - Container for the necessary parameters to execute the ExecuteChangeSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ExecuteChangeSet service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - The specified change set can't be used to update the stack. For example, the change - set status might be CREATE_IN_PROGRESS, or the stack status might be - UPDATE_IN_PROGRESS. - - - A client request token already exists. - - REST API Reference for ExecuteChangeSet Operation - - - - Returns the stack policy for a specified stack. If a stack doesn't have a policy, - a null value is returned. - - Container for the necessary parameters to execute the GetStackPolicy service method. - - The response from the GetStackPolicy service method, as returned by CloudFormation. - REST API Reference for GetStackPolicy Operation - - - - Returns the stack policy for a specified stack. If a stack doesn't have a policy, - a null value is returned. - - Container for the necessary parameters to execute the GetStackPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetStackPolicy service method, as returned by CloudFormation. - REST API Reference for GetStackPolicy Operation - - - - Returns the template body for a specified stack. You can get the template for running - or deleted stacks. - - - - For deleted stacks, GetTemplate returns the template for up to 90 days after the stack - has been deleted. - - - - If the template does not exist, a ValidationError is returned. - - - - Container for the necessary parameters to execute the GetTemplate service method. - - The response from the GetTemplate service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for GetTemplate Operation - - - - Returns the template body for a specified stack. You can get the template for running - or deleted stacks. - - - - For deleted stacks, GetTemplate returns the template for up to 90 days after the stack - has been deleted. - - - - If the template does not exist, a ValidationError is returned. - - - - Container for the necessary parameters to execute the GetTemplate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetTemplate service method, as returned by CloudFormation. - - The specified change set name or ID doesn't exit. To view valid change sets for a - stack, use the ListChangeSets action. - - REST API Reference for GetTemplate Operation - - - - Returns information about a new or existing template. The GetTemplateSummary - action is useful for viewing parameter information, such as default parameter values - and parameter types, before you create or update a stack or stack set. - - - - You can use the GetTemplateSummary action when you submit a template, - or you can get template information for a stack set, or a running or deleted stack. - - - - For deleted stacks, GetTemplateSummary returns the template information - for up to 90 days after the stack has been deleted. If the template does not exist, - a ValidationError is returned. - - - Container for the necessary parameters to execute the GetTemplateSummary service method. - - The response from the GetTemplateSummary service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for GetTemplateSummary Operation - - - - Returns information about a new or existing template. The GetTemplateSummary - action is useful for viewing parameter information, such as default parameter values - and parameter types, before you create or update a stack or stack set. - - - - You can use the GetTemplateSummary action when you submit a template, - or you can get template information for a stack set, or a running or deleted stack. - - - - For deleted stacks, GetTemplateSummary returns the template information - for up to 90 days after the stack has been deleted. If the template does not exist, - a ValidationError is returned. - - - Container for the necessary parameters to execute the GetTemplateSummary service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetTemplateSummary service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for GetTemplateSummary Operation - - - - Returns the ID and status of each active change set for a stack. For example, AWS - CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - CREATE_PENDING state. - - Container for the necessary parameters to execute the ListChangeSets service method. - - The response from the ListChangeSets service method, as returned by CloudFormation. - REST API Reference for ListChangeSets Operation - - - - Returns the ID and status of each active change set for a stack. For example, AWS - CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - CREATE_PENDING state. - - Container for the necessary parameters to execute the ListChangeSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListChangeSets service method, as returned by CloudFormation. - REST API Reference for ListChangeSets Operation - - - - Lists all exported output values in the account and Region in which you call this - action. Use this action to see the exported output values that you can import into - other stacks. To import values, use the - Fn::ImportValue function. - - - - For more information, see - AWS CloudFormation Export Stack Output Values. - - - Container for the necessary parameters to execute the ListExports service method. - - The response from the ListExports service method, as returned by CloudFormation. - REST API Reference for ListExports Operation - - - - Lists all exported output values in the account and Region in which you call this - action. Use this action to see the exported output values that you can import into - other stacks. To import values, use the - Fn::ImportValue function. - - - - For more information, see - AWS CloudFormation Export Stack Output Values. - - - Container for the necessary parameters to execute the ListExports service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListExports service method, as returned by CloudFormation. - REST API Reference for ListExports Operation - - - - Lists all stacks that are importing an exported output value. To modify or remove - an exported output value, first use this action to see which stacks are using it. - To see the exported output values in your account, see ListExports. - - - - For more information about importing an exported output value, see the - Fn::ImportValue function. - - - Container for the necessary parameters to execute the ListImports service method. - - The response from the ListImports service method, as returned by CloudFormation. - REST API Reference for ListImports Operation - - - - Lists all stacks that are importing an exported output value. To modify or remove - an exported output value, first use this action to see which stacks are using it. - To see the exported output values in your account, see ListExports. - - - - For more information about importing an exported output value, see the - Fn::ImportValue function. - - - Container for the necessary parameters to execute the ListImports service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListImports service method, as returned by CloudFormation. - REST API Reference for ListImports Operation - - - - Returns summary information about stack instances that are associated with the specified - stack set. You can filter for stack instances that are associated with a specific - AWS account name or Region, or that have a specific status. - - Container for the necessary parameters to execute the ListStackInstances service method. - - The response from the ListStackInstances service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackInstances Operation - - - - Returns summary information about stack instances that are associated with the specified - stack set. You can filter for stack instances that are associated with a specific - AWS account name or Region, or that have a specific status. - - Container for the necessary parameters to execute the ListStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackInstances service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackInstances Operation - - - - Returns descriptions of all resources of the specified stack. - - - - For deleted stacks, ListStackResources returns resource information for up to 90 days - after the stack has been deleted. - - - Container for the necessary parameters to execute the ListStackResources service method. - - The response from the ListStackResources service method, as returned by CloudFormation. - REST API Reference for ListStackResources Operation - - - - Returns descriptions of all resources of the specified stack. - - - - For deleted stacks, ListStackResources returns resource information for up to 90 days - after the stack has been deleted. - - - Container for the necessary parameters to execute the ListStackResources service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackResources service method, as returned by CloudFormation. - REST API Reference for ListStackResources Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - Container for the necessary parameters to execute the ListStacks service method. - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns the summary information for stacks whose status matches the specified StackStatusFilter. - Summary information for stacks that have been deleted is kept for 90 days after the - stack is deleted. If no StackStatusFilter is specified, summary information for all - stacks is returned (including existing stacks and stacks that have been deleted). - - Container for the necessary parameters to execute the ListStacks service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStacks service method, as returned by CloudFormation. - REST API Reference for ListStacks Operation - - - - Returns summary information about the results of a stack set operation. - - Container for the necessary parameters to execute the ListStackSetOperationResults service method. - - The response from the ListStackSetOperationResults service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperationResults Operation - - - - Returns summary information about the results of a stack set operation. - - Container for the necessary parameters to execute the ListStackSetOperationResults service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSetOperationResults service method, as returned by CloudFormation. - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperationResults Operation - - - - Returns summary information about operations performed on a stack set. - - Container for the necessary parameters to execute the ListStackSetOperations service method. - - The response from the ListStackSetOperations service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperations Operation - - - - Returns summary information about operations performed on a stack set. - - Container for the necessary parameters to execute the ListStackSetOperations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSetOperations service method, as returned by CloudFormation. - - The specified stack set doesn't exist. - - REST API Reference for ListStackSetOperations Operation - - - - Returns summary information about stack sets that are associated with the user. - -
  • - - [Self-managed permissions] If you set the CallAs parameter to SELF - while signed in to your AWS account, ListStackSets returns all self-managed - stack sets in your AWS account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to SELF - while signed in to the organization's management account, ListStackSets - returns all stack sets in the management account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN - while signed in to your member account, ListStackSets returns all stack - sets with service-managed permissions in the management account. - -
- - Container for the necessary parameters to execute the ListStackSets service method. - - The response from the ListStackSets service method, as returned by CloudFormation. - REST API Reference for ListStackSets Operation - - - - Returns summary information about stack sets that are associated with the user. - -
  • - - [Self-managed permissions] If you set the CallAs parameter to SELF - while signed in to your AWS account, ListStackSets returns all self-managed - stack sets in your AWS account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to SELF - while signed in to the organization's management account, ListStackSets - returns all stack sets in the management account. - -
  • - - [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN - while signed in to your member account, ListStackSets returns all stack - sets with service-managed permissions in the management account. - -
- - Container for the necessary parameters to execute the ListStackSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListStackSets service method, as returned by CloudFormation. - REST API Reference for ListStackSets Operation - - - - Returns a list of registration tokens for the specified extension(s). - - Container for the necessary parameters to execute the ListTypeRegistrations service method. - - The response from the ListTypeRegistrations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeRegistrations Operation - - - - Returns a list of registration tokens for the specified extension(s). - - Container for the necessary parameters to execute the ListTypeRegistrations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypeRegistrations service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeRegistrations Operation - - - - Returns summary information about extension that have been registered with CloudFormation. - - Container for the necessary parameters to execute the ListTypes service method. - - The response from the ListTypes service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypes Operation - - - - Returns summary information about extension that have been registered with CloudFormation. - - Container for the necessary parameters to execute the ListTypes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypes service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypes Operation - - - - Returns summary information about the versions of an extension. - - Container for the necessary parameters to execute the ListTypeVersions service method. - - The response from the ListTypeVersions service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeVersions Operation - - - - Returns summary information about the versions of an extension. - - Container for the necessary parameters to execute the ListTypeVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTypeVersions service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for ListTypeVersions Operation - - - - Publishes the specified extension to the CloudFormation registry as a public extension - in this region. Public extensions are available for use by all CloudFormation users. - For more information on publishing extensions, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - To publish an extension, you must be registered as a publisher with CloudFormation. - For more information, see RegisterPublisher. - - - Container for the necessary parameters to execute the PublishType service method. - - The response from the PublishType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for PublishType Operation - - - - Publishes the specified extension to the CloudFormation registry as a public extension - in this region. Public extensions are available for use by all CloudFormation users. - For more information on publishing extensions, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - - To publish an extension, you must be registered as a publisher with CloudFormation. - For more information, see RegisterPublisher. - - - Container for the necessary parameters to execute the PublishType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PublishType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for PublishType Operation - - - - Reports progress of a resource handler to CloudFormation. - - - - Reserved for use by the CloudFormation - CLI. Do not use this API in your code. - - - Container for the necessary parameters to execute the RecordHandlerProgress service method. - - The response from the RecordHandlerProgress service method, as returned by CloudFormation. - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - REST API Reference for RecordHandlerProgress Operation - - - - Reports progress of a resource handler to CloudFormation. - - - - Reserved for use by the CloudFormation - CLI. Do not use this API in your code. - - - Container for the necessary parameters to execute the RecordHandlerProgress service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RecordHandlerProgress service method, as returned by CloudFormation. - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - - Error reserved for use by the CloudFormation - CLI. CloudFormation does not return this error to users. - - REST API Reference for RecordHandlerProgress Operation - - - - Registers your account as a publisher of public extensions in the CloudFormation registry. - Public extensions are available for use by all CloudFormation users. This publisher - ID applies to your account in all AWS regions. - - - - For information on requirements for registering as a public extension publisher, see - Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the RegisterPublisher service method. - - The response from the RegisterPublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterPublisher Operation - - - - Registers your account as a publisher of public extensions in the CloudFormation registry. - Public extensions are available for use by all CloudFormation users. This publisher - ID applies to your account in all AWS regions. - - - - For information on requirements for registering as a public extension publisher, see - Registering - your account to publish CloudFormation extensions in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the RegisterPublisher service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterPublisher service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterPublisher Operation - - - - Registers an extension with the CloudFormation service. Registering an extension makes - it available for use in CloudFormation templates in your AWS account, and includes: - -
  • - - Validating the extension schema - -
  • - - Determining which handlers, if any, have been specified for the extension - -
  • - - Making the extension available for use in your account - -
- - For more information on how to develop extensions and ready them for registeration, - see Creating - Resource Providers in the CloudFormation CLI User Guide. - - - - You can have a maximum of 50 resource extension versions registered at a time. This - maximum is per account and per region. Use DeregisterType - to deregister specific extension versions if necessary. - - - - Once you have initiated a registration request using RegisterType , - you can use DescribeTypeRegistration to monitor the progress - of the registration request. - - - - Once you have registered a private extension in your account and region, use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the RegisterType service method. - - The response from the RegisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterType Operation - - - - Registers an extension with the CloudFormation service. Registering an extension makes - it available for use in CloudFormation templates in your AWS account, and includes: - -
  • - - Validating the extension schema - -
  • - - Determining which handlers, if any, have been specified for the extension - -
  • - - Making the extension available for use in your account - -
- - For more information on how to develop extensions and ready them for registeration, - see Creating - Resource Providers in the CloudFormation CLI User Guide. - - - - You can have a maximum of 50 resource extension versions registered at a time. This - maximum is per account and per region. Use DeregisterType - to deregister specific extension versions if necessary. - - - - Once you have initiated a registration request using RegisterType , - you can use DescribeTypeRegistration to monitor the progress - of the registration request. - - - - Once you have registered a private extension in your account and region, use SetTypeConfiguration - to specify configuration properties for the extension. For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - Container for the necessary parameters to execute the RegisterType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - REST API Reference for RegisterType Operation - - - - Sets a stack policy for a specified stack. - - Container for the necessary parameters to execute the SetStackPolicy service method. - - The response from the SetStackPolicy service method, as returned by CloudFormation. - REST API Reference for SetStackPolicy Operation - - - - Sets a stack policy for a specified stack. - - Container for the necessary parameters to execute the SetStackPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetStackPolicy service method, as returned by CloudFormation. - REST API Reference for SetStackPolicy Operation - - - - Specifies the configuration data for a registered CloudFormation extension, in the - given account and region. - - - - To view the current configuration data for an extension, refer to the ConfigurationSchema - element of DescribeType. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - It is strongly recommended that you use dynamic references to restrict sensitive configuration - definitions, such as third-party credentials. For more details on dynamic references, - see Using dynamic references to specify template - values in the AWS CloudFormation User Guide. - - - - Container for the necessary parameters to execute the SetTypeConfiguration service method. - - The response from the SetTypeConfiguration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeConfiguration Operation - - - - Specifies the configuration data for a registered CloudFormation extension, in the - given account and region. - - - - To view the current configuration data for an extension, refer to the ConfigurationSchema - element of DescribeType. - For more information, see Configuring - extensions at the account level in the CloudFormation User Guide. - - - - It is strongly recommended that you use dynamic references to restrict sensitive configuration - definitions, such as third-party credentials. For more details on dynamic references, - see Using dynamic references to specify template - values in the AWS CloudFormation User Guide. - - - - Container for the necessary parameters to execute the SetTypeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetTypeConfiguration service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeConfiguration Operation - - - - Specify the default version of an extension. The default version of an extension will - be used in CloudFormation operations. - - Container for the necessary parameters to execute the SetTypeDefaultVersion service method. - - The response from the SetTypeDefaultVersion service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeDefaultVersion Operation - - - - Specify the default version of an extension. The default version of an extension will - be used in CloudFormation operations. - - Container for the necessary parameters to execute the SetTypeDefaultVersion service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetTypeDefaultVersion service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for SetTypeDefaultVersion Operation - - - - Sends a signal to the specified resource with a success or failure status. You can - use the SignalResource API in conjunction with a creation policy or update policy. - AWS CloudFormation doesn't proceed with a stack creation or update until resources - receive the required number of signals or the timeout period is exceeded. The SignalResource - API is useful in cases where you want to send signals from anywhere other than an - Amazon EC2 instance. - - Container for the necessary parameters to execute the SignalResource service method. - - The response from the SignalResource service method, as returned by CloudFormation. - REST API Reference for SignalResource Operation - - - - Sends a signal to the specified resource with a success or failure status. You can - use the SignalResource API in conjunction with a creation policy or update policy. - AWS CloudFormation doesn't proceed with a stack creation or update until resources - receive the required number of signals or the timeout period is exceeded. The SignalResource - API is useful in cases where you want to send signals from anywhere other than an - Amazon EC2 instance. - - Container for the necessary parameters to execute the SignalResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SignalResource service method, as returned by CloudFormation. - REST API Reference for SignalResource Operation - - - - Stops an in-progress operation on a stack set and its associated stack instances. - - Container for the necessary parameters to execute the StopStackSetOperation service method. - - The response from the StopStackSetOperation service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for StopStackSetOperation Operation - - - - Stops an in-progress operation on a stack set and its associated stack instances. - - Container for the necessary parameters to execute the StopStackSetOperation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopStackSetOperation service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified ID refers to an operation that doesn't exist. - - - The specified stack set doesn't exist. - - REST API Reference for StopStackSetOperation Operation - - - - Tests a registered extension to make sure it meets all necessary requirements for - being published in the CloudFormation registry. - -
  • - - For resource types, this includes passing all contracts tests defined for the type. - -
  • - - For modules, this includes determining if the module's model meets all necessary requirements. - -
- - For more information, see Testing - your public extension prior to publishing in the CloudFormation CLI User Guide. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in your account and region for testing. - - - - To perform testing, CloudFormation assumes the execution role specified when the test - was registered. For more information, see RegisterType. - - - - Once you've initiated testing on an extension using TestType, you can - use DescribeType - to monitor the current test status and test status description for the extension. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the TestType service method. - - The response from the TestType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for TestType Operation - - - - Tests a registered extension to make sure it meets all necessary requirements for - being published in the CloudFormation registry. - -
  • - - For resource types, this includes passing all contracts tests defined for the type. - -
  • - - For modules, this includes determining if the module's model meets all necessary requirements. - -
- - For more information, see Testing - your public extension prior to publishing in the CloudFormation CLI User Guide. - - - - If you do not specify a version, CloudFormation uses the default version of the extension - in your account and region for testing. - - - - To perform testing, CloudFormation assumes the execution role specified when the test - was registered. For more information, see RegisterType. - - - - Once you've initiated testing on an extension using TestType, you can - use DescribeType - to monitor the current test status and test status description for the extension. - - - - An extension must have a test status of PASSED before it can be published. - For more information, see Publishing - extensions to make them available for public use in the CloudFormation CLI - User Guide. - - - Container for the necessary parameters to execute the TestType service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TestType service method, as returned by CloudFormation. - - An error occurred during a CloudFormation registry operation. - - - The specified extension does not exist in the CloudFormation registry. - - REST API Reference for TestType Operation - - - - Updates a stack as specified in the template. After the call completes successfully, - the stack update starts. You can check the status of the stack via the DescribeStacks - action. - - - - To get a copy of the template for an existing stack, you can use the GetTemplate - action. - - - - For more information about creating an update template, updating a stack, and monitoring - the progress of the update, see Updating - a Stack. - - - Container for the necessary parameters to execute the UpdateStack service method. - - The response from the UpdateStack service method, as returned by CloudFormation. - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - A client request token already exists. - - REST API Reference for UpdateStack Operation - - - - Updates a stack as specified in the template. After the call completes successfully, - the stack update starts. You can check the status of the stack via the DescribeStacks - action. - - - - To get a copy of the template for an existing stack, you can use the GetTemplate - action. - - - - For more information about creating an update template, updating a stack, and monitoring - the progress of the update, see Updating - a Stack. - - - Container for the necessary parameters to execute the UpdateStack service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStack service method, as returned by CloudFormation. - - The template contains resources with capabilities that weren't specified in the Capabilities - parameter. - - - A client request token already exists. - - REST API Reference for UpdateStack Operation - - - - Updates the parameter values for stack instances for the specified accounts, within - the specified Regions. A stack instance refers to a stack in a specific account and - Region. - - - - You can only update stack instances in Regions and accounts where they already exist; - to create additional stack instances, use CreateStackInstances. - - - - - During stack set updates, any parameters overridden for a stack instance are not updated, - but retain their overridden value. - - - - You can only update the parameter values that are specified in the stack set; - to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. If you add a parameter to a template, before you - can override the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - Container for the necessary parameters to execute the UpdateStackInstances service method. - - The response from the UpdateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackInstances Operation - - - - Updates the parameter values for stack instances for the specified accounts, within - the specified Regions. A stack instance refers to a stack in a specific account and - Region. - - - - You can only update stack instances in Regions and accounts where they already exist; - to create additional stack instances, use CreateStackInstances. - - - - - During stack set updates, any parameters overridden for a stack instance are not updated, - but retain their overridden value. - - - - You can only update the parameter values that are specified in the stack set; - to add or delete a parameter itself, use UpdateStackSet - to update the stack set template. If you add a parameter to a template, before you - can override the parameter value specified in the stack set you must first use UpdateStackSet - to update all stack instances with the updated template and parameter value specified - in the stack set. Once a stack instance has been updated with the new parameter, you - can then override the parameter value using UpdateStackInstances. - - - Container for the necessary parameters to execute the UpdateStackInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStackInstances service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackInstances Operation - - - - Updates the stack set, and associated stack instances in the specified accounts and - Regions. - - - - Even if the stack set operation created by updating the stack set fails (completely - or partially, below or above a specified failure tolerance), the stack set is updated - with your changes. Subsequent CreateStackInstances calls on the specified stack - set use the updated stack set. - - - Container for the necessary parameters to execute the UpdateStackSet service method. - - The response from the UpdateStackSet service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackSet Operation - - - - Updates the stack set, and associated stack instances in the specified accounts and - Regions. - - - - Even if the stack set operation created by updating the stack set fails (completely - or partially, below or above a specified failure tolerance), the stack set is updated - with your changes. Subsequent CreateStackInstances calls on the specified stack - set use the updated stack set. - - - Container for the necessary parameters to execute the UpdateStackSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateStackSet service method, as returned by CloudFormation. - - The specified operation isn't valid. - - - The specified operation ID already exists. - - - Another operation is currently in progress for this stack set. Only one operation - can be performed for a stack set at a given time. - - - The specified stack instance doesn't exist. - - - The specified stack set doesn't exist. - - - Another operation has been performed on this stack set since the specified operation - was performed. - - REST API Reference for UpdateStackSet Operation - - - - Updates termination protection for the specified stack. If a user attempts to delete - a stack with termination protection enabled, the operation fails and the stack remains - unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - Container for the necessary parameters to execute the UpdateTerminationProtection service method. - - The response from the UpdateTerminationProtection service method, as returned by CloudFormation. - REST API Reference for UpdateTerminationProtection Operation - - - - Updates termination protection for the specified stack. If a user attempts to delete - a stack with termination protection enabled, the operation fails and the stack remains - unchanged. For more information, see Protecting - a Stack From Being Deleted in the AWS CloudFormation User Guide. - - - - For nested - stacks, termination protection is set on the root stack and cannot be changed - directly on the nested stack. - - - Container for the necessary parameters to execute the UpdateTerminationProtection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateTerminationProtection service method, as returned by CloudFormation. - REST API Reference for UpdateTerminationProtection Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - Container for the necessary parameters to execute the ValidateTemplate service method. - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - - Validates a specified template. AWS CloudFormation first checks if the template is - valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. - If both these checks fail, AWS CloudFormation returns a template validation error. - - Container for the necessary parameters to execute the ValidateTemplate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateTemplate service method, as returned by CloudFormation. - REST API Reference for ValidateTemplate Operation - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta deleted file mode 100644 index 3a48f049..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 6ced5f7be14b53441b6d6814a7bd00a9 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml deleted file mode 100644 index 2cd7f85e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.CognitoIdentityProvider.xml +++ /dev/null @@ -1,41954 +0,0 @@ - - - - AWSSDK.CognitoIdentityProvider - - - - - Configuration for accessing Amazon CognitoIdentityProvider service - - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Common exception for the CognitoIdentityProvider service. - - - - - Construct instance of AmazonCognitoIdentityProviderException - - - - - - Construct instance of AmazonCognitoIdentityProviderException - - - - - - - Construct instance of AmazonCognitoIdentityProviderException - - - - - - Construct instance of AmazonCognitoIdentityProviderException - - - - - - - - - - Construct instance of AmazonCognitoIdentityProviderException - - - - - - - - - - - Constructs a new instance of the AmazonCognitoIdentityProviderException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Service metadata for Amazon CognitoIdentityProvider service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The data type for AccountRecoverySetting. - - - - - Gets and sets the property RecoveryMechanisms. - - The list of RecoveryOptionTypes. - - - - - - Account takeover actions type. - - - - - Gets and sets the property HighAction. - - Action to take for a high risk. - - - - - - Gets and sets the property LowAction. - - Action to take for a low risk. - - - - - - Gets and sets the property MediumAction. - - Action to take for a medium risk. - - - - - - Account takeover action type. - - - - - Gets and sets the property EventAction. - - The event action. - -
  • - - BLOCK Choosing this action will block the request. - -
  • - - MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else - allow the request. - -
  • - - MFA_REQUIRED Throw MFA challenge if user has configured it, else block - the request. - -
  • - - NO_ACTION Allow the user sign-in. - -
- - - - - Gets and sets the property Notify. - - Flag specifying whether to send a notification. - - - - - - Configuration for mitigation actions and notification for different levels of risk - detected for a potential account takeover. - - - - - Gets and sets the property Actions. - - Account takeover risk configuration actions - - - - - - Gets and sets the property NotifyConfiguration. - - The notify configuration used to construct email notifications. - - - - - - Container for the parameters to the AddCustomAttributes operation. - Adds additional user attributes to the user pool schema. - - - - - Gets and sets the property CustomAttributes. - - An array of custom attributes, such as Mutable and Name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to add custom attributes. - - - - - - Represents the response from the server for the request to add custom attributes. - - - - - Container for the parameters to the AdminAddUserToGroup operation. - Adds the specified user to the specified group. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property GroupName. - - The group name. - - - - - - Gets and sets the property Username. - - The username for the user. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the AdminAddUserToGroup operation. - - - - - Container for the parameters to the AdminConfirmSignUp operation. - Confirms user registration as an admin without using a confirmation code. Works on - any user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - If your user pool configuration includes triggers, the AdminConfirmSignUp API action - invokes the AWS Lambda function that is specified for the post confirmation - trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which - the function receives as input. In this payload, the clientMetadata attribute - provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp - request. In your function code in AWS Lambda, you can process the ClientMetadata value - to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property Username. - - The user name for which you want to confirm user registration. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for which you want to confirm user registration. - - - - - - Represents the response from the server for the request to confirm registration. - - - - - The configuration for creating a new user profile. - - - - - Gets and sets the property AllowAdminCreateUserOnly. - - Set to True if only the administrator is allowed to create user profiles. - Set to False if users can sign themselves up via an app. - - - - - - Gets and sets the property InviteMessageTemplate. - - The message template to be used for the welcome message to new users. - - - - See also Customizing - User Invitation Messages. - - - - - - Gets and sets the property UnusedAccountValidityDays. - - The user account expiration limit, in days, after which the account is no longer usable. - To reset the account after that time limit, you must call AdminCreateUser - again, specifying "RESEND" for the MessageAction parameter. - The default value for this parameter is 7. - - - - If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, - that value will be used and UnusedAccountValidityDays will be deprecated - for that user pool. - - - - - - - Container for the parameters to the AdminCreateUser operation. - Creates a new user in the specified user pool. - - - - If MessageAction is not set, the default is to send a welcome message - via email or phone (SMS). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - This message is based on a template that you configured in your call to create or - update a user pool. This template includes your custom sign-up instructions and placeholders - for user name and temporary password. - - - - Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction - parameter, and Amazon Cognito will not send any email. - - - - In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - they sign in and change their password. - - - - AdminCreateUser requires developer credentials. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the AdminCreateUser API action, Amazon Cognito invokes the function that - is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, - it passes a JSON payload, which the function receives as input. This payload contains - a clientMetadata attribute, which provides the data that you assigned - to the ClientMetadata parameter in your AdminCreateUser request. In your function - code in AWS Lambda, you can process the clientMetadata value to enhance - your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property DesiredDeliveryMediums. - - Specify "EMAIL" if email will be used to send the welcome message. Specify - "SMS" if the phone number will be used. The default value is "SMS". - More than one value can be specified. - - - - - - Gets and sets the property ForceAliasCreation. - - This parameter is only used if the phone_number_verified or email_verified - attribute is set to True. Otherwise, it is ignored. - - - - If this parameter is set to True and the phone number or email address - specified in the UserAttributes parameter already exists as an alias with a different - user, the API call will migrate the alias from the previous user to the newly created - user. The previous user will no longer be able to log in using that alias. - - - - If this parameter is set to False, the API throws an AliasExistsException - error if the alias already exists. The default value is False. - - - - - - Gets and sets the property MessageAction. - - Set to "RESEND" to resend the invitation message to a user that already - exists and reset the expiration limit on the user's account. Set to "SUPPRESS" - to suppress sending the message. Only one value can be specified. - - - - - - Gets and sets the property TemporaryPassword. - - The user's temporary password. This password must conform to the password policy that - you specified when you created the user pool. - - - - The temporary password is valid only once. To complete the Admin Create User flow, - the user must enter the temporary password in the sign-in page along with a new password - to be used in all future sign-ins. - - - - This parameter is not required. If you do not specify a value, Amazon Cognito generates - one for you. - - - - The temporary password can only be used until the user account expiration limit that - you specified when you created the user pool. To reset the account after that time - limit, you must call AdminCreateUser again, specifying "RESEND" - for the MessageAction parameter. - - - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs that contain user attributes and attribute values to - be set for the user to be created. You can create a user without specifying any attributes - other than Username. However, any attributes that you specify as required - (when creating a user pool or in the Attributes tab of the console) must be - supplied either by you (in your call to AdminCreateUser) or by the user - (when he or she signs up in response to your welcome message). - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - To send a message inviting the user to sign up, you must specify the user's email - address or phone number. This can be done in your call to AdminCreateUser or in the - Users tab of the Amazon Cognito console for managing your user pools. - - - - In your call to AdminCreateUser, you can set the email_verified - attribute to True, and you can set the phone_number_verified - attribute to True. (You can also do this by calling AdminUpdateUserAttributes.) - -
  • - - email: The email address of the user to whom the message that contains the - code and username will be sent. Required if the email_verified attribute - is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums - parameter. - -
  • - - phone_number: The phone number of the user to whom the message that contains - the code and username will be sent. Required if the phone_number_verified - attribute is set to True, or if "SMS" is specified in the - DesiredDeliveryMediums parameter. - -
- - - - - Gets and sets the property Username. - - The username for the user. Must be unique within the user pool. Must be a UTF-8 string - between 1 and 128 characters. After the user is created, the username cannot be changed. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where the user will be created. - - - - - - Gets and sets the property ValidationData. - - The user's validation data. This is an array of name-value pairs that contain user - attributes and attribute values that you can use for custom validation, such as restricting - the types of user accounts that can be registered. For example, you might choose to - allow or disallow user sign-up based on the user's domain. - - - - To configure custom validation, you must create a Pre Sign-up Lambda trigger for the - user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives - the validation data and uses it in the validation process. - - - - The user's validation data is not persisted. - - - - - - Represents the response from the server to the request to create the user. - - - - - Gets and sets the property User. - - The newly created user. - - - - - - Container for the parameters to the AdminDeleteUserAttributes operation. - Deletes the user attributes in a user pool as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property UserAttributeNames. - - An array of strings representing the user attribute names you wish to delete. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Gets and sets the property Username. - - The user name of the user from which you would like to delete attributes. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to delete user attributes. - - - - - - Represents the response received from the server for a request to delete user attributes. - - - - - Container for the parameters to the AdminDeleteUser operation. - Deletes a user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to delete. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to delete the user. - - - - - - This is the response object from the AdminDeleteUser operation. - - - - - Container for the parameters to the AdminDisableProviderForUser operation. - Disables the user from signing in with the specified external (SAML or social) identity - provider. If the user to disable is a Cognito User Pools native username + password - user, they are not permitted to use their password to sign-in. If the user to disable - is a linked external IdP user, any link between that user and an existing user is - removed. The next time the external user (no longer attached to the previously linked - DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. - - - - This action is enabled only for admin access and requires developer credentials. - - - - The ProviderName must match the value specified when creating an IdP - for the pool. - - - - To disable a native username + password user, the ProviderName value - must be Cognito and the ProviderAttributeName must be Cognito_Subject, - with the ProviderAttributeValue being the name that is used in the user - pool for the user. - - - - The ProviderAttributeName must always be Cognito_Subject - for social identity providers. The ProviderAttributeValue must always - be the exact subject that was used when the user was originally linked as a source - user. - - - - For de-linking a SAML identity, there are two scenarios. If the linked identity has - not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue - must be the same values that were used for the SourceUser when the identities - were originally linked using AdminLinkProviderForUser call. (If the - linking was done with ProviderAttributeName set to Cognito_Subject, - the same applies here). However, if the user has already signed in, the ProviderAttributeName - must be Cognito_Subject and ProviderAttributeValue must - be the subject of the SAML assertion. - - - - - - Gets and sets the property User. - - The user to be disabled. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the AdminDisableProviderForUser operation. - - - - - Container for the parameters to the AdminDisableUser operation. - Disables the specified user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to disable. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to disable the user. - - - - - - Represents the response received from the server to disable the user as an administrator. - - - - - Container for the parameters to the AdminEnableUser operation. - Enables the specified user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to enable. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to enable the user. - - - - - - Represents the response from the server for the request to enable a user as an administrator. - - - - - Container for the parameters to the AdminForgetDevice operation. - Forgets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property Username. - - The user name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the AdminForgetDevice operation. - - - - - Container for the parameters to the AdminGetDevice operation. - Gets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property Username. - - The user name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - Gets the device response, as an administrator. - - - - - Gets and sets the property Device. - - The device. - - - - - - Container for the parameters to the AdminGetUser operation. - Gets the specified user by user name in a user pool as an administrator. Works on - any user. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to retrieve. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to get information about the user. - - - - - - Represents the response from the server from the request to get the specified user - as an administrator. - - - - - Gets and sets the property Enabled. - - Indicates that the status is enabled. - - - - - - Gets and sets the property MFAOptions. - - This response parameter is no longer supported. It provides information only - about SMS MFA configurations. It doesn't provide information about TOTP software token - MFA configurations. To look up information about either type of MFA configuration, - use UserMFASettingList instead. - - - - - - Gets and sets the property PreferredMfaSetting. - - The user's preferred MFA setting. - - - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs representing user attributes. - - - - - - Gets and sets the property UserCreateDate. - - The date the user was created. - - - - - - Gets and sets the property UserLastModifiedDate. - - The date the user was last modified. - - - - - - Gets and sets the property UserMFASettingList. - - The MFA options that are enabled for the user. The possible values in this list are - SMS_MFA and SOFTWARE_TOKEN_MFA. - - - - - - Gets and sets the property Username. - - The user name of the user about whom you are receiving information. - - - - - - Gets and sets the property UserStatus. - - The user status. Can be one of the following: - -
  • - - UNCONFIRMED - User has been created but not confirmed. - -
  • - - CONFIRMED - User has been confirmed. - -
  • - - ARCHIVED - User is no longer active. - -
  • - - COMPROMISED - User is disabled due to a potential security threat. - -
  • - - UNKNOWN - User status is not known. - -
  • - - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his - or her password before he or she can sign in. - -
  • - - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary - password, but on first sign-in, the user must change his or her password to a new - value before doing anything else. - -
- - - - - Container for the parameters to the AdminInitiateAuth operation. - Initiates the authentication flow, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property AnalyticsMetadata. - - The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth - calls. - - - - - - Gets and sets the property AuthFlow. - - The authentication flow for this call to execute. The API action will depend on this - value. For example: - -
  • - - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new - tokens. - -
  • - - USER_SRP_AUTH will take in USERNAME and SRP_A - and return the SRP variables to be used for next challenge execution. - -
  • - - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD - and return the next challenge or tokens. - -
- - Valid values include: - -
  • - - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) - protocol. - -
  • - - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for - refreshing the access token and ID token by supplying a valid refresh token. - -
  • - - CUSTOM_AUTH: Custom authentication flow. - -
  • - - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the - USERNAME and PASSWORD directly if the flow is enabled for calling the app client. - -
  • - - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD - are passed directly. If a user migration Lambda trigger is set, this flow will invoke - the user migration Lambda if the USERNAME is not found in the user pool. - -
  • - - ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. - This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, - Cognito receives the password in the request instead of using the SRP process to verify - passwords. - -
- - - - - Gets and sets the property AuthParameters. - - The authentication parameters. These are inputs corresponding to the AuthFlow - that you are invoking. The required values depend on the value of AuthFlow: - -
  • - - For USER_SRP_AUTH: USERNAME (required), SRP_A - (required), SECRET_HASH (required if the app client is configured with - a client secret), DEVICE_KEY. - -
  • - - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), - SECRET_HASH (required if the app client is configured with a client secret), - DEVICE_KEY. - -
  • - - For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH - (if app client is configured with client secret), PASSWORD (required), - DEVICE_KEY. - -
  • - - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH - (if app client is configured with client secret), DEVICE_KEY. To start - the authentication flow with password verification, include ChallengeName: SRP_A - and SRP_A: (The SRP_A Value). - -
- - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for certain custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda - functions that are specified for various triggers. The ClientMetadata value is passed - as input to the functions for only the following triggers: - -
  • - - Pre signup - -
  • - - Pre authentication - -
  • - - User migration - -
- - When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, - which the function receives as input. This payload contains a validationData - attribute, which provides the data that you assigned to the ClientMetadata parameter - in your AdminInitiateAuth request. In your function code in AWS Lambda, you can process - the validationData value to enhance your workflow for your specific needs. - - - - When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions - for the following triggers, but it does not provide the ClientMetadata value as input: - -
  • - - Post authentication - -
  • - - Custom message - -
  • - - Pre token generation - -
  • - - Create auth challenge - -
  • - - Define auth challenge - -
  • - - Verify auth challenge - -
- - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property ContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property UserPoolId. - - The ID of the Amazon Cognito user pool. - - - - - - Initiates the authentication response, as an administrator. - - - - - Gets and sets the property AuthenticationResult. - - The result of the authentication response. This is only returned if the caller does - not need to pass another challenge. If the caller does need to pass another challenge - before it gets tokens, ChallengeName, ChallengeParameters, - and Session are returned. - - - - - - Gets and sets the property ChallengeName. - - The name of the challenge which you are responding to with this call. This is returned - to you in the AdminInitiateAuth response if you need to pass another - challenge. - -
  • - - MFA_SETUP: If MFA is required, users who do not have at least one of - the MFA methods set up are presented with an MFA_SETUP challenge. The - user must set up at least one MFA type to continue to authenticate. - -
  • - - SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA - for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA. - -
  • - - SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered - via SMS. - -
  • - - PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, - PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side - SRP calculations. - -
  • - - CUSTOM_CHALLENGE: This is returned if your custom authentication flow - determines that the user should pass another challenge before tokens are issued. - -
  • - - DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and - the previous challenges were passed, this challenge is returned so that Amazon Cognito - can start tracking this device. - -
  • - - DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, - but for devices only. - -
  • - - ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with - USERNAME and PASSWORD directly. An app client must be enabled - to use this flow. - -
  • - - NEW_PASSWORD_REQUIRED: For users who are required to change their passwords - after successful first login. This challenge should be passed with NEW_PASSWORD - and any other required attributes. - -
  • - - MFA_SETUP: For users who are required to setup an MFA factor before - they can sign-in. The MFA types enabled for the user pool will be listed in the challenge - parameters MFA_CAN_SETUP value. - - - - To setup software token MFA, use the session returned here from InitiateAuth - as an input to AssociateSoftwareToken, and use the session returned by - VerifySoftwareToken as an input to RespondToAuthChallenge - with challenge name MFA_SETUP to complete sign-in. To setup SMS MFA, - users will need help from an administrator to add a phone number to their account - and then call InitiateAuth again to restart sign-in. - -
- - - - - Gets and sets the property ChallengeParameters. - - The challenge parameters. These are returned to you in the AdminInitiateAuth - response if you need to pass another challenge. The responses in this parameter should - be used to compute inputs to the next call (AdminRespondToAuthChallenge). - - - - All challenges require USERNAME and SECRET_HASH (if applicable). - - - - The value of the USER_ID_FOR_SRP attribute will be the user's actual - username, not an alias (such as email address or phone number), even if you specified - an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge - API ChallengeResponses, the USERNAME attribute cannot be - an alias. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If AdminInitiateAuth or AdminRespondToAuthChallenge API - call determines that the caller needs to go through another challenge, they return - a session with other challenge parameters. This session should be passed as it is - to the next AdminRespondToAuthChallenge API call. - - - - - - Container for the parameters to the AdminLinkProviderForUser operation. - Links an existing user account in a user pool (DestinationUser) to an - identity from an external identity provider (SourceUser) based on a specified - attribute name and value from the external identity provider. This allows you to create - a link from the existing user account to an external federated user identity that - has not yet been used to sign in, so that the federated user identity can be used - to sign in as the existing user account. - - - - For example, if there is an existing user with a username and password, this API - links that user to a federated user identity, so that when the federated user identity - is used, the user signs in as the existing user account. - - - - The maximum number of federated identities linked to a user is 5. - - - - Because this API allows a user with an external federated identity to sign in as an - existing user in the user pool, it is critical that it only be used with external - identity providers and provider attributes that have been trusted by the application - owner. - - - - This action is enabled only for admin access and requires developer credentials. - - - - - - Gets and sets the property DestinationUser. - - The existing user in the user pool to be linked to the external identity provider - user account. Can be a native (Username + Password) Cognito User Pools user or a federated - user (for example, a SAML or Facebook user). If the user doesn't exist, an exception - is thrown. This is the user that is returned when the new user (with the linked identity - provider attribute) signs in. - - - - For a native username + password user, the ProviderAttributeValue for - the DestinationUser should be the username in the user pool. For a federated - user, it should be the provider-specific user_id. - - - - The ProviderAttributeName of the DestinationUser is ignored. - - - - The ProviderName should be set to Cognito for users in Cognito - user pools. - - - - - - Gets and sets the property SourceUser. - - An external identity provider account for a user who does not currently exist yet - in the user pool. This user must be a federated user (for example, a SAML or Facebook - user), not another native user. - - - - If the SourceUser is a federated social identity provider user (Facebook, - Google, or Login with Amazon), you must set the ProviderAttributeName - to Cognito_Subject. For social identity providers, the ProviderName - will be Facebook, Google, or LoginWithAmazon, - and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens - for id, sub, and user_id, respectively. The - ProviderAttributeValue for the user must be the same value as the id, - sub, or user_id value found in the social identity provider - token. - - - - For SAML, the ProviderAttributeName can be any value that matches a claim - in the SAML assertion. If you wish to link SAML users based on the subject of the - SAML assertion, you should map the subject to a claim through the SAML identity provider - and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName - to Cognito_Subject, Cognito will automatically parse the default unique - identifier found in the subject from the SAML token. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the AdminLinkProviderForUser operation. - - - - - Container for the parameters to the AdminListDevices operation. - Lists devices, as an administrator. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Limit. - - The limit of the devices request. - - - - - - Gets and sets the property PaginationToken. - - The pagination token. - - - - - - Gets and sets the property Username. - - The user name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - Lists the device's response, as an administrator. - - - - - Gets and sets the property Devices. - - The devices in the list of devices response. - - - - - - Gets and sets the property PaginationToken. - - The pagination token. - - - - - - Container for the parameters to the AdminListGroupsForUser operation. - Lists the groups that the user belongs to. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Limit. - - The limit of the request to list groups. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property Username. - - The username for the user. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the AdminListGroupsForUser operation. - - - - - Gets and sets the property Groups. - - The groups that the user belongs to. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Container for the parameters to the AdminListUserAuthEvents operation. - Lists a history of user activity and any risks detected as part of Amazon Cognito - advanced security. - - - - - Gets and sets the property MaxResults. - - The maximum number of authentication events to return. - - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Gets and sets the property Username. - - The user pool username or an alias. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the AdminListUserAuthEvents operation. - - - - - Gets and sets the property AuthEvents. - - The response object. It includes the EventID, EventType, - CreationDate, EventRisk, and EventResponse. - - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Container for the parameters to the AdminRemoveUserFromGroup operation. - Removes the specified user from the specified group. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property GroupName. - - The group name. - - - - - - Gets and sets the property Username. - - The username for the user. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the AdminRemoveUserFromGroup operation. - - - - - Container for the parameters to the AdminResetUserPassword operation. - Resets the specified user's password in a user pool as an administrator. Works on - any user. - - - - When a developer calls this API, the current password is invalidated, so it must be - changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException - exception back and should direct the user down the flow to reset the password, which - is the same as the forgot password flow. In addition, if the user pool has phone verification - selected and a verified phone number exists for the user, or if email verification - is selected and a verified email exists for the user, calling this API will also result - in sending a message to the end user with the code to change their password. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function - that is assigned to the custom message trigger. When Amazon Cognito invokes - this function, it passes a JSON payload, which the function receives as input. This - payload contains a clientMetadata attribute, which provides the data - that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. - In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property Username. - - The user name of the user whose password you wish to reset. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to reset the user's password. - - - - - - Represents the response from the server to reset a user password as an administrator. - - - - - Container for the parameters to the AdminRespondToAuthChallenge operation. - Responds to an authentication challenge, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property AnalyticsMetadata. - - The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge - calls. - - - - - - Gets and sets the property ChallengeName. - - The challenge name. For more information, see AdminInitiateAuth. - - - - - - Gets and sets the property ChallengeResponses. - - The challenge responses. These are inputs corresponding to the value of ChallengeName, - for example: - -
  • - - SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH - (if app client is configured with client secret). - -
  • - - PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, - TIMESTAMP, USERNAME, SECRET_HASH (if app client - is configured with client secret). - -
  • - - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH - (if app client is configured with client secret). - -
  • - - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required - attributes, USERNAME, SECRET_HASH (if app client is configured - with client secret). - -
  • - - MFA_SETUP requires USERNAME, plus you need to use the session - value returned by VerifySoftwareToken in the Session parameter. - -
- - The value of the USERNAME attribute must be the user's actual username, - not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth - response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP - attribute, even if you specified an alias in your call to AdminInitiateAuth. - - - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any - functions that are assigned to the following triggers: pre sign-up, custom - message, post authentication, user migration, pre token generation, - define auth challenge, create auth challenge, and verify auth challenge - response. When Amazon Cognito invokes any of these functions, it passes a JSON - payload, which the function receives as input. This payload contains a clientMetadata - attribute, which provides the data that you assigned to the ClientMetadata parameter - in your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, - you can process the clientMetadata value to enhance your workflow for - your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property ContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If InitiateAuth or RespondToAuthChallenge API call determines - that the caller needs to go through another challenge, they return a session with - other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge - API call. - - - - - - Gets and sets the property UserPoolId. - - The ID of the Amazon Cognito user pool. - - - - - - Responds to the authentication challenge, as an administrator. - - - - - Gets and sets the property AuthenticationResult. - - The result returned by the server in response to the authentication request. - - - - - - Gets and sets the property ChallengeName. - - The name of the challenge. For more information, see AdminInitiateAuth. - - - - - - Gets and sets the property ChallengeParameters. - - The challenge parameters. For more information, see AdminInitiateAuth. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If the caller needs to go through another challenge, they return a session with other - challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge - API call. - - - - - - Container for the parameters to the AdminSetUserMFAPreference operation. - Sets the user's multi-factor authentication (MFA) preference, including which MFA - options are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. - - - - - Gets and sets the property SMSMfaSettings. - - The SMS text message MFA settings. - - - - - - Gets and sets the property SoftwareTokenMfaSettings. - - The time-based one-time password software token MFA settings. - - - - - - Gets and sets the property Username. - - The user pool username or alias. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the AdminSetUserMFAPreference operation. - - - - - Container for the parameters to the AdminSetUserPassword operation. - Sets the specified user's password in a user pool as an administrator. Works on any - user. - - - - The password can be temporary or permanent. If it is temporary, the user status will - be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries - to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED - challenge. If the user does not sign in before it expires, the user will not be able - to sign in and their password will need to be reset by an administrator. - - - - Once the user has set a new password, or the password is permanent, the user status - will be set to Confirmed. - - - - - - Gets and sets the property Password. - - The password for the user. - - - - - - Gets and sets the property Permanent. - - True if the password is permanent, False if it is temporary. - - - - - - Gets and sets the property Username. - - The user name of the user whose password you wish to set. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to set the user's password. - - - - - - This is the response object from the AdminSetUserPassword operation. - - - - - Container for the parameters to the AdminSetUserSettings operation. - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use AdminSetUserMFAPreference - instead. - - - - - Gets and sets the property MFAOptions. - - You can use this parameter only to set an SMS configuration that uses SMS for delivery. - - - - - - Gets and sets the property Username. - - The user name of the user that you are setting options for. - - - - - - Gets and sets the property UserPoolId. - - The ID of the user pool that contains the user that you are setting options for. - - - - - - Represents the response from the server to set user settings as an administrator. - - - - - Container for the parameters to the AdminUpdateAuthEventFeedback operation. - Provides feedback for an authentication event as to whether it was from a valid user. - This feedback is used for improving the risk evaluation decision for the user pool - as part of Amazon Cognito advanced security. - - - - - Gets and sets the property EventId. - - The authentication event ID. - - - - - - Gets and sets the property FeedbackValue. - - The authentication event feedback value. - - - - - - Gets and sets the property Username. - - The user pool username. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the AdminUpdateAuthEventFeedback operation. - - - - - Container for the parameters to the AdminUpdateDeviceStatus operation. - Updates the device status as an administrator. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property DeviceRememberedStatus. - - The status indicating whether a device has been remembered or not. - - - - - - Gets and sets the property Username. - - The user name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - The status response from the request to update the device, as an administrator. - - - - - Container for the parameters to the AdminUpdateUserAttributes operation. - Updates the specified user's attributes, including developer attributes, as an administrator. - Works on any user. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - In addition to updating user attributes, this API can also be used to mark phone and - email as verified. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the - function that is assigned to the custom message trigger. When Amazon Cognito - invokes this function, it passes a JSON payload, which the function receives as input. - This payload contains a clientMetadata attribute, which provides the - data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes - request. In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs representing user attributes. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Gets and sets the property Username. - - The user name of the user for whom you want to update user attributes. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to update user attributes. - - - - - - Represents the response from the server for the request to update user attributes - as an administrator. - - - - - Container for the parameters to the AdminUserGlobalSignOut operation. - Signs out users from all devices, as an administrator. It also invalidates all refresh - tokens issued to a user. The user's current access and Id tokens remain valid until - their expiry. Access and Id tokens expire one hour after they are issued. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Username. - - The user name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - The global sign-out response, as an administrator. - - - - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - - - Constructs a new AliasExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of AliasExistsException - - - - - - - Construct instance of AliasExistsException - - - - - - Construct instance of AliasExistsException - - - - - - - - - - - Construct instance of AliasExistsException - - - - - - - - - - Constructs a new instance of the AliasExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The Amazon Pinpoint analytics configuration for collecting metrics for a user pool. - - - - In regions where Pinpoint is not available, Cognito User Pools only supports sending - events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, - Cognito User Pools will support sending events to Amazon Pinpoint projects within - that same region. - - - - - - - Gets and sets the property ApplicationArn. - - The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon - Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon - Cognito publishes events to the pinpoint project declared by the app ARN. - - - - - - Gets and sets the property ApplicationId. - - The application ID for an Amazon Pinpoint application. - - - - - - Gets and sets the property ExternalId. - - The external ID. - - - - - - Gets and sets the property RoleArn. - - The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon - Pinpoint analytics. - - - - - - Gets and sets the property UserDataShared. - - If UserDataShared is true, Amazon Cognito will include user - data in the events it publishes to Amazon Pinpoint analytics. - - - - - - An Amazon Pinpoint analytics endpoint. - - - - An endpoint uniquely identifies a mobile device, email address, or phone number that - can receive messages from Amazon Pinpoint analytics. - - - - Cognito User Pools only supports sending events to Amazon Pinpoint projects in the - US East (N. Virginia) us-east-1 Region, regardless of the region in which the user - pool resides. - - - - - - - Gets and sets the property AnalyticsEndpointId. - - The endpoint ID. - - - - - - Container for the parameters to the AssociateSoftwareToken operation. - Returns a unique generated shared secret key code for the user account. The request - takes an access token or a session string, but not both. - - - - Calling AssociateSoftwareToken immediately disassociates the existing software token - from the user account. If the user doesn't subsequently verify the software token, - their account is essentially set up to authenticate without MFA. If MFA config is - set to Optional at the user pool level, the user can then login without MFA. However, - if MFA is set to Required for the user pool, the user will be asked to setup a new - software token MFA during sign in. - - - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - This allows authentication of the user as part of the MFA setup process. - - - - - - This is the response object from the AssociateSoftwareToken operation. - - - - - Gets and sets the property SecretCode. - - A unique generated shared secret code that is used in the TOTP algorithm to generate - a one time code. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - This allows authentication of the user as part of the MFA setup process. - - - - - - Specifies whether the attribute is standard or custom. - - - - - Gets and sets the property Name. - - The name of the attribute. - - - - - - Gets and sets the property Value. - - The value of the attribute. - - - - - - The authentication result. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property ExpiresIn. - - The expiration period of the authentication result in seconds. - - - - - - Gets and sets the property IdToken. - - The ID token. - - - - - - Gets and sets the property NewDeviceMetadata. - - The new device metadata from an authentication result. - - - - - - Gets and sets the property RefreshToken. - - The refresh token. - - - - - - Gets and sets the property TokenType. - - The token type. - - - - - - The authentication event type. - - - - - Gets and sets the property ChallengeResponses. - - The challenge responses. - - - - - - Gets and sets the property CreationDate. - - The creation date - - - - - - Gets and sets the property EventContextData. - - The user context data captured at the time of an event request. It provides additional - information about the client from which event the request is received. - - - - - - Gets and sets the property EventFeedback. - - A flag specifying the user feedback captured at the time of an event request is good - or bad. - - - - - - Gets and sets the property EventId. - - The event ID. - - - - - - Gets and sets the property EventResponse. - - The event response. - - - - - - Gets and sets the property EventRisk. - - The event risk. - - - - - - Gets and sets the property EventType. - - The event type. - - - - - - The challenge response type. - - - - - Gets and sets the property ChallengeName. - - The challenge name - - - - - - Gets and sets the property ChallengeResponse. - - The challenge response. - - - - - - Container for the parameters to the ChangePassword operation. - Changes the password for a specified user in a user pool. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property PreviousPassword. - - The old password. - - - - - - Gets and sets the property ProposedPassword. - - The new password. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response from the server to the change password request. - - - - - The code delivery details being returned from the server. - - - - - Gets and sets the property AttributeName. - - The attribute name. - - - - - - Gets and sets the property DeliveryMedium. - - The delivery medium (email message or phone number). - - - - - - Gets and sets the property Destination. - - The destination for the code delivery details. - - - - - - This exception is thrown when a verification code fails to deliver successfully. - - - - - Constructs a new CodeDeliveryFailureException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of CodeDeliveryFailureException - - - - - - - Construct instance of CodeDeliveryFailureException - - - - - - Construct instance of CodeDeliveryFailureException - - - - - - - - - - - Construct instance of CodeDeliveryFailureException - - - - - - - - - - Constructs a new instance of the CodeDeliveryFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown if the provided code does not match what the server was expecting. - - - - - Constructs a new CodeMismatchException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of CodeMismatchException - - - - - - - Construct instance of CodeMismatchException - - - - - - Construct instance of CodeMismatchException - - - - - - - - - - - Construct instance of CodeMismatchException - - - - - - - - - - Constructs a new instance of the CodeMismatchException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The compromised credentials actions type - - - - - Gets and sets the property EventAction. - - The event action. - - - - - - The compromised credentials risk configuration type. - - - - - Gets and sets the property Actions. - - The compromised credentials risk configuration actions. - - - - - - Gets and sets the property EventFilter. - - Perform the action for these events. The default is to perform all events if no event - filter is specified. - - - - - - This exception is thrown if two or more modifications are happening concurrently. - - - - - Constructs a new ConcurrentModificationException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ConcurrentModificationException - - - - - - - Construct instance of ConcurrentModificationException - - - - - - Construct instance of ConcurrentModificationException - - - - - - - - - - - Construct instance of ConcurrentModificationException - - - - - - - - - - Constructs a new instance of the ConcurrentModificationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the ConfirmDevice operation. - Confirms tracking of the device. This API call is the call that begins device tracking. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property DeviceName. - - The device name. - - - - - - Gets and sets the property DeviceSecretVerifierConfig. - - The configuration of the device secret verifier. - - - - - - Confirms the device response. - - - - - Gets and sets the property UserConfirmationNecessary. - - Indicates whether the user confirmation is necessary to confirm the device response. - - - - - - Container for the parameters to the ConfirmForgotPassword operation. - Allows a user to enter a confirmation code to reset a forgotten password. - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword - calls. - - - - - - Gets and sets the property ClientId. - - The app client ID of the app associated with the user pool. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function - that is assigned to the post confirmation trigger. When Amazon Cognito invokes - this function, it passes a JSON payload, which the function receives as input. This - payload contains a clientMetadata attribute, which provides the data - that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. - In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property ConfirmationCode. - - The confirmation code sent by a user's request to retrieve a forgotten password. For - more information, see ForgotPassword. - - - - - - Gets and sets the property Password. - - The password sent by a user's request to retrieve a forgotten password. - - - - - - Gets and sets the property SecretHash. - - A keyed-hash message authentication code (HMAC) calculated using the secret key of - a user pool client and username plus the client ID in the message. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Username. - - The user name of the user for whom you want to enter a code to retrieve a forgotten - password. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response from the server that results from a user's request to retrieve a forgotten - password. - - - - - Container for the parameters to the ConfirmSignUp operation. - Confirms registration of a user and handles the existing alias from a previous user. - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp - calls. - - - - - - Gets and sets the property ClientId. - - The ID of the app client associated with the user pool. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that - is assigned to the post confirmation trigger. When Amazon Cognito invokes this - function, it passes a JSON payload, which the function receives as input. This payload - contains a clientMetadata attribute, which provides the data that you - assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function - code in AWS Lambda, you can process the clientMetadata value to enhance - your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property ConfirmationCode. - - The confirmation code sent by a user's request to confirm registration. - - - - - - Gets and sets the property ForceAliasCreation. - - Boolean to be specified to force user confirmation irrespective of existing alias. - By default set to False. If this parameter is set to True - and the phone number/email used for sign up confirmation already exists as an alias - with a different user, the API call will migrate the alias from the previous user - to the newly created user being confirmed. If set to False, the API will - throw an AliasExistsException error. - - - - - - Gets and sets the property SecretHash. - - A keyed-hash message authentication code (HMAC) calculated using the secret key of - a user pool client and username plus the client ID in the message. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Username. - - The user name of the user whose registration you wish to confirm. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Represents the response from the server for the registration confirmation. - - - - - Contextual user data type used for evaluating the risk of an unexpected event by Amazon - Cognito advanced security. - - - - - Gets and sets the property EncodedData. - - Encoded data containing device fingerprinting details, collected using the Amazon - Cognito context data collection library. - - - - - - Gets and sets the property HttpHeaders. - - HttpHeaders received on your server in same order. - - - - - - Gets and sets the property IpAddress. - - Source IP address of your user. - - - - - - Gets and sets the property ServerName. - - Your server endpoint where this API is invoked. - - - - - - Gets and sets the property ServerPath. - - Your server path where this API is invoked. - - - - - - Container for the parameters to the CreateGroup operation. - Creates a new group in the specified user pool. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Description. - - A string containing the description of the group. - - - - - - Gets and sets the property GroupName. - - The name of the group. Must be unique. - - - - - - Gets and sets the property Precedence. - - A nonnegative integer value that specifies the precedence of this group relative to - the other groups that a user can belong to in the user pool. Zero is the highest precedence - value. Groups with lower Precedence values take precedence over groups - with higher or null Precedence values. If a user belongs to two or more - groups, it is the group with the lowest precedence value whose role ARN will be used - in the cognito:roles and cognito:preferred_role claims in - the user's tokens. - - - - Two groups can have the same Precedence value. If this happens, neither - group takes precedence over the other. If two groups with the same Precedence - have the same role ARN, that role is used in the cognito:preferred_role - claim in tokens for users in each group. If the two groups have different role ARNs, - the cognito:preferred_role claim is not set in users' tokens. - - - - The default Precedence value is null. - - - - - - Gets and sets the property RoleArn. - - The role ARN for the group. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the CreateGroup operation. - - - - - Gets and sets the property Group. - - The group object for the group. - - - - - - Container for the parameters to the CreateIdentityProvider operation. - Creates an identity provider for a user pool. - - - - - Gets and sets the property AttributeMapping. - - A mapping of identity provider attributes to standard and custom user pool attributes. - - - - - - Gets and sets the property IdpIdentifiers. - - A list of identity provider identifiers. - - - - - - Gets and sets the property ProviderDetails. - - The identity provider details. The following list describes the provider detail keys - for each identity provider type. - -
  • - - For Google and Login with Amazon: - -
    • - - client_id - -
    • - - client_secret - -
    • - - authorize_scopes - -
  • - - For Facebook: - -
    • - - client_id - -
    • - - client_secret - -
    • - - authorize_scopes - -
    • - - api_version - -
  • - - For Sign in with Apple: - -
    • - - client_id - -
    • - - team_id - -
    • - - key_id - -
    • - - private_key - -
    • - - authorize_scopes - -
  • - - For OIDC providers: - -
    • - - client_id - -
    • - - client_secret - -
    • - - attributes_request_method - -
    • - - oidc_issuer - -
    • - - authorize_scopes - -
    • - - authorize_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - token_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - attributes_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - jwks_uri if not available from discovery URL specified by oidc_issuer key - -
  • - - For SAML providers: - -
    • - - MetadataFile OR MetadataURL - -
    • - - IDPSignout optional - -
- - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property ProviderType. - - The identity provider type. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the CreateIdentityProvider operation. - - - - - Gets and sets the property IdentityProvider. - - The newly created identity provider object. - - - - - - Container for the parameters to the CreateResourceServer operation. - Creates a new OAuth2.0 resource server and defines custom scopes in it. - - - - - Gets and sets the property Identifier. - - A unique resource server identifier for the resource server. This could be an HTTPS - endpoint where the resource server is located. For example, https://my-weather-api.example.com. - - - - - - Gets and sets the property Name. - - A friendly name for the resource server. - - - - - - Gets and sets the property Scopes. - - A list of scopes. Each scope is map, where the keys are name and description. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the CreateResourceServer operation. - - - - - Gets and sets the property ResourceServer. - - The newly created resource server. - - - - - - Container for the parameters to the CreateUserImportJob operation. - Creates the user import job. - - - - - Gets and sets the property CloudWatchLogsRoleArn. - - The role ARN for the Amazon CloudWatch Logging role for the user import job. - - - - - - Gets and sets the property JobName. - - The job name for the user import job. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - Represents the response from the server to the request to create the user import job. - - - - - Gets and sets the property UserImportJob. - - The job object that represents the user import job. - - - - - - Container for the parameters to the CreateUserPoolClient operation. - Creates the user pool client. - - - - When you create a new user pool client, token revocation is automatically enabled. - For more information about revoking tokens, see RevokeToken. - - - - - - Gets and sets the property AccessTokenValidity. - - The time limit, between 5 minutes and 1 day, after which the access token is no longer - valid and cannot be used. This value will be overridden if you have entered a value - in TokenValidityUnits. - - - - - - Gets and sets the property AllowedOAuthFlows. - - The allowed OAuth flows. - - - - Set to code to initiate a code grant flow, which provides an authorization - code as the response. This code can be exchanged for access tokens with the token - endpoint. - - - - Set to implicit to specify that the client should get the access token - (and, optionally, ID token, based on scopes) directly. - - - - Set to client_credentials to specify that the client should get the access - token (and, optionally, ID token, based on scopes) from the token endpoint using a - combination of client and client_secret. - - - - - - Gets and sets the property AllowedOAuthFlowsUserPoolClient. - - Set to true if the client is allowed to follow the OAuth protocol when interacting - with Cognito user pools. - - - - - - Gets and sets the property AllowedOAuthScopes. - - The allowed OAuth scopes. Possible values provided by OAuth are: phone, - email, openid, and profile. Possible values - provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created - in Resource Servers are also supported. - - - - - - Gets and sets the property AnalyticsConfiguration. - - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. - - - - In regions where Pinpoint is not available, Cognito User Pools only supports sending - events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, - Cognito User Pools will support sending events to Amazon Pinpoint projects within - that same region. - - - - - - - Gets and sets the property CallbackURLs. - - A list of allowed redirect (callback) URLs for the identity providers. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property ClientName. - - The client name for the user pool client you would like to create. - - - - - - Gets and sets the property DefaultRedirectURI. - - The default redirect URI. Must be in the CallbackURLs list. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property EnableTokenRevocation. - - Enables or disables token revocation. For more information about revoking tokens, - see RevokeToken. - - - - If you don't include this parameter, token revocation is automatically enabled for - the new user pool client. - - - - - - Gets and sets the property ExplicitAuthFlows. - - The authentication flows that are supported by the user pool clients. Flow names without - the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ - prefix. Note that values with ALLOW_ prefix cannot be used along with - values without ALLOW_ prefix. - - - - Valid values include: - -
  • - - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - setting. With this authentication flow, Cognito receives the password in the request - instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. - -
  • - - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. - -
  • - - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. - In this flow, Cognito receives the password in the request instead of using the SRP - protocol to verify passwords. - -
  • - - ALLOW_USER_SRP_AUTH: Enable SRP based authentication. - -
  • - - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - -
- - - - - Gets and sets the property GenerateSecret. - - Boolean to specify whether you want to generate a secret for the user pool client - being created. - - - - - - Gets and sets the property IdTokenValidity. - - The time limit, between 5 minutes and 1 day, after which the ID token is no longer - valid and cannot be used. This value will be overridden if you have entered a value - in TokenValidityUnits. - - - - - - Gets and sets the property LogoutURLs. - - A list of allowed logout URLs for the identity providers. - - - - - - Gets and sets the property PreventUserExistenceErrors. - - Use this setting to choose which errors and responses are returned by Cognito APIs - during authentication, account confirmation, and password recovery when the user does - not exist in the user pool. When set to ENABLED and the user does not - exist, authentication returns an error indicating either the username or password - was incorrect, and account confirmation and password recovery return a response indicating - a code was sent to a simulated destination. When set to LEGACY, those - APIs will return a UserNotFoundException exception if the user does not - exist in the user pool. - - - - Valid values include: - -
  • - - ENABLED - This prevents user existence-related errors. - -
  • - - LEGACY - This represents the old behavior of Cognito where user existence - related errors are not prevented. - -
- - After February 15th 2020, the value of PreventUserExistenceErrors will - default to ENABLED for newly created user pool clients if no value is - provided. - - - - - - - Gets and sets the property ReadAttributes. - - The read attributes. - - - - - - Gets and sets the property RefreshTokenValidity. - - The time limit, in days, after which the refresh token is no longer valid and cannot - be used. - - - - - - Gets and sets the property SupportedIdentityProviders. - - A list of provider names for the identity providers that are supported on this client. - The following are supported: COGNITO, Facebook, Google - and LoginWithAmazon. - - - - - - Gets and sets the property TokenValidityUnits. - - The units in which the validity times are represented in. Default for RefreshToken - is days, and default for ID and access tokens are hours. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to create a user pool client. - - - - - - Gets and sets the property WriteAttributes. - - The user pool attributes that the app client can write to. - - - - If your app client allows users to sign in through an identity provider, this array - must include all attributes that are mapped to identity provider attributes. Amazon - Cognito updates mapped attributes when users sign in to your application through an - identity provider. If your app client lacks write access to a mapped attribute, Amazon - Cognito throws an error when it attempts to update the attribute. For more information, - see Specifying - Identity Provider Attribute Mappings for Your User Pool. - - - - - - Represents the response from the server to create a user pool client. - - - - - Gets and sets the property UserPoolClient. - - The user pool client that was just created. - - - - - - Container for the parameters to the CreateUserPoolDomain operation. - Creates a new domain for a user pool. - - - - - Gets and sets the property CustomDomainConfig. - - The configuration for a custom domain that hosts the sign-up and sign-in webpages - for your application. - - - - Provide this parameter only if you want to use a custom domain for your user pool. - Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain - instead. - - - - For more information about the hosted domain and custom domains, see Configuring - a User Pool Domain. - - - - - - Gets and sets the property Domain. - - The domain string. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the CreateUserPoolDomain operation. - - - - - Gets and sets the property CloudFrontDomain. - - The Amazon CloudFront endpoint that you use as the target of the alias that you set - up with your Domain Name Service (DNS) provider. - - - - - - Container for the parameters to the CreateUserPool operation. - Creates a new Amazon Cognito user pool and sets the password policy for the pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AccountRecoverySetting. - - Use this setting to define which verified available method a user can use to recover - their password when they call ForgotPassword. It allows you to define - a preferred method when a user has more than one method available. With this setting, - SMS does not qualify for a valid password recovery mechanism if the user also has - SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior - to determine the recovery method where SMS is preferred over email. - - - - - - Gets and sets the property AdminCreateUserConfig. - - The configuration for AdminCreateUser requests. - - - - - - Gets and sets the property AliasAttributes. - - Attributes supported as an alias for this user pool. Possible values: phone_number, - email, or preferred_username. - - - - - - Gets and sets the property AutoVerifiedAttributes. - - The attributes to be auto-verified. Possible values: email, phone_number. - - - - - - Gets and sets the property DeviceConfiguration. - - The device configuration. - - - - - - Gets and sets the property EmailConfiguration. - - The email configuration. - - - - - - Gets and sets the property EmailVerificationMessage. - - A string representing the email verification message. EmailVerificationMessage is - allowed only if EmailSendingAccount - is DEVELOPER. - - - - - - Gets and sets the property EmailVerificationSubject. - - A string representing the email verification subject. EmailVerificationSubject is - allowed only if EmailSendingAccount - is DEVELOPER. - - - - - - Gets and sets the property LambdaConfig. - - The Lambda trigger configuration information for the new user pool. - - - - In a push model, event sources (such as Amazon S3 and custom applications) need permission - to invoke a function. So you will need to make an extra call to add permission for - these event sources to invoke your Lambda function. - - - - For more information on using the Lambda API to add permission, see - AddPermission . - - - - For adding permission using the AWS CLI, see - add-permission . - - - - - - - Gets and sets the property MfaConfiguration. - - Specifies MFA configuration details. - - - - - - Gets and sets the property Policies. - - The policies associated with the new user pool. - - - - - - Gets and sets the property PoolName. - - A string used to name the user pool. - - - - - - Gets and sets the property Schema. - - An array of schema attributes for the new user pool. These attributes can be standard - or custom attributes. - - - - - - Gets and sets the property SmsAuthenticationMessage. - - A string representing the SMS authentication message. - - - - - - Gets and sets the property SmsConfiguration. - - The SMS configuration. - - - - - - Gets and sets the property SmsVerificationMessage. - - A string representing the SMS verification message. - - - - - - Gets and sets the property UsernameAttributes. - - Specifies whether email addresses or phone numbers can be specified as usernames when - a user signs up. - - - - - - Gets and sets the property UsernameConfiguration. - - You can choose to set case sensitivity on the username input for the selected sign-in - option. For example, when this is set to False, users will be able to - sign in using either "username" or "Username". This configuration is immutable once - it has been set. For more information, see UsernameConfigurationType. - - - - - - Gets and sets the property UserPoolAddOns. - - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode - to the value "AUDIT". - - - - - - Gets and sets the property UserPoolTags. - - The tag keys and values to assign to the user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - - - Gets and sets the property VerificationMessageTemplate. - - The template for the verification message that the user sees when the app requests - permission to access the user's information. - - - - - - Represents the response from the server for the request to create a user pool. - - - - - Gets and sets the property UserPool. - - A container for the user pool details. - - - - - - The configuration for a custom domain that hosts the sign-up and sign-in webpages - for your application. - - - - - Gets and sets the property CertificateArn. - - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You - use this certificate for the subdomain of your custom domain. - - - - - - A custom email sender Lambda configuration type. - - - - - Gets and sets the property LambdaArn. - - The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers - to send email notifications to users. - - - - - - Gets and sets the property LambdaVersion. - - The Lambda version represents the signature of the "request" attribute in the "event" - information Amazon Cognito passes to your custom email Lambda function. The only supported - value is V1_0. - - - - - - A custom SMS sender Lambda configuration type. - - - - - Gets and sets the property LambdaArn. - - The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers - to send SMS notifications to users. - - - - - - Gets and sets the property LambdaVersion. - - The Lambda version represents the signature of the "request" attribute in the "event" - information Amazon Cognito passes to your custom SMS Lambda function. The only supported - value is V1_0. - - - - - - Container for the parameters to the DeleteGroup operation. - Deletes a group. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property GroupName. - - The name of the group. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the DeleteGroup operation. - - - - - Container for the parameters to the DeleteIdentityProvider operation. - Deletes an identity provider for a user pool. - - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the DeleteIdentityProvider operation. - - - - - Container for the parameters to the DeleteResourceServer operation. - Deletes a resource server. - - - - - Gets and sets the property Identifier. - - The identifier for the resource server. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that hosts the resource server. - - - - - - This is the response object from the DeleteResourceServer operation. - - - - - Container for the parameters to the DeleteUserAttributes operation. - Deletes the attributes for a user. - - - - - Gets and sets the property AccessToken. - - The access token used in the request to delete user attributes. - - - - - - Gets and sets the property UserAttributeNames. - - An array of strings representing the user attribute names you wish to delete. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Represents the response from the server to delete user attributes. - - - - - Container for the parameters to the DeleteUserPoolClient operation. - Allows the developer to delete the user pool client. - - - - - Gets and sets the property ClientId. - - The app client ID of the app associated with the user pool. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to delete the client. - - - - - - This is the response object from the DeleteUserPoolClient operation. - - - - - Container for the parameters to the DeleteUserPoolDomain operation. - Deletes a domain for a user pool. - - - - - Gets and sets the property Domain. - - The domain string. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the DeleteUserPoolDomain operation. - - - - - Container for the parameters to the DeleteUserPool operation. - Deletes the specified Amazon Cognito user pool. - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool you want to delete. - - - - - - This is the response object from the DeleteUserPool operation. - - - - - Container for the parameters to the DeleteUser operation. - Allows a user to delete himself or herself. - - - - - Gets and sets the property AccessToken. - - The access token from a request to delete a user. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - This is the response object from the DeleteUser operation. - - - - - Container for the parameters to the DescribeIdentityProvider operation. - Gets information about a specific identity provider. - - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the DescribeIdentityProvider operation. - - - - - Gets and sets the property IdentityProvider. - - The identity provider that was deleted. - - - - - - Container for the parameters to the DescribeResourceServer operation. - Describes a resource server. - - - - - Gets and sets the property Identifier. - - The identifier for the resource server - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that hosts the resource server. - - - - - - This is the response object from the DescribeResourceServer operation. - - - - - Gets and sets the property ResourceServer. - - The resource server. - - - - - - Container for the parameters to the DescribeRiskConfiguration operation. - Describes the risk configuration. - - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the DescribeRiskConfiguration operation. - - - - - Gets and sets the property RiskConfiguration. - - The risk configuration. - - - - - - Container for the parameters to the DescribeUserImportJob operation. - Describes the user import job. - - - - - Gets and sets the property JobId. - - The job ID for the user import job. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - Represents the response from the server to the request to describe the user import - job. - - - - - Gets and sets the property UserImportJob. - - The job object that represents the user import job. - - - - - - Container for the parameters to the DescribeUserPoolClient operation. - Client method for returning the configuration information and metadata of the specified - user pool app client. - - - - - Gets and sets the property ClientId. - - The app client ID of the app associated with the user pool. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool you want to describe. - - - - - - Represents the response from the server from a request to describe the user pool client. - - - - - Gets and sets the property UserPoolClient. - - The user pool client from a server response to describe the user pool client. - - - - - - Container for the parameters to the DescribeUserPoolDomain operation. - Gets information about a domain. - - - - - Gets and sets the property Domain. - - The domain string. - - - - - - This is the response object from the DescribeUserPoolDomain operation. - - - - - Gets and sets the property DomainDescription. - - A domain description object containing information about the domain. - - - - - - Container for the parameters to the DescribeUserPool operation. - Returns the configuration information and metadata of the specified user pool. - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool you want to describe. - - - - - - Represents the response to describe the user pool. - - - - - Gets and sets the property UserPool. - - The container of metadata returned by the server to describe the pool. - - - - - - The configuration for the user pool's device tracking. - - - - - Gets and sets the property ChallengeRequiredOnNewDevice. - - Indicates whether a challenge is required on a new device. Only applicable to a new - device. - - - - - - Gets and sets the property DeviceOnlyRememberedOnUserPrompt. - - If true, a device is only remembered on user prompt. - - - - - - The device verifier against which it will be authenticated. - - - - - Gets and sets the property PasswordVerifier. - - The password verifier. - - - - - - Gets and sets the property Salt. - - The salt. - - - - - - The device type. - - - - - Gets and sets the property DeviceAttributes. - - The device attributes. - - - - - - Gets and sets the property DeviceCreateDate. - - The creation date of the device. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property DeviceLastAuthenticatedDate. - - The date in which the device was last authenticated. - - - - - - Gets and sets the property DeviceLastModifiedDate. - - The last modified date of the device. - - - - - - A container for information about a domain. - - - - - Gets and sets the property AWSAccountId. - - The AWS account ID for the user pool owner. - - - - - - Gets and sets the property CloudFrontDistribution. - - The ARN of the CloudFront distribution. - - - - - - Gets and sets the property CustomDomainConfig. - - The configuration for a custom domain that hosts the sign-up and sign-in webpages - for your application. - - - - - - Gets and sets the property Domain. - - The domain string. - - - - - - Gets and sets the property S3Bucket. - - The S3 bucket where the static files for this domain are stored. - - - - - - Gets and sets the property Status. - - The domain status. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - Gets and sets the property Version. - - The app version. - - - - - - This exception is thrown when the provider is already supported by the user pool. - - - - - Constructs a new DuplicateProviderException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of DuplicateProviderException - - - - - - - Construct instance of DuplicateProviderException - - - - - - Construct instance of DuplicateProviderException - - - - - - - - - - - Construct instance of DuplicateProviderException - - - - - - - - - - Constructs a new instance of the DuplicateProviderException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The email configuration type. - - - - Amazon Cognito has specific regions for use with Amazon SES. For more information - on the supported regions, see Email - Settings for Amazon Cognito User Pools. - - - - - - - Gets and sets the property ConfigurationSet. - - The set of configuration rules that can be applied to emails sent using Amazon SES. - A configuration set is applied to an email by including a reference to the configuration - set in the headers of the email. Once applied, all of the rules in that configuration - set are applied to the email. Configuration sets can be used to apply the following - types of rules to emails: - -
  • - - Event publishing – Amazon SES can track the number of send, delivery, open, click, - bounce, and complaint events for each email sent. Use event publishing to send information - about these events to other AWS services such as SNS and CloudWatch. - -
  • - - IP pool management – When leasing dedicated IP addresses with Amazon SES, you can - create groups of IP addresses, called dedicated IP pools. You can then associate the - dedicated IP pools with configuration sets. - -
- - - - - Gets and sets the property EmailSendingAccount. - - Specifies whether Amazon Cognito emails your users by using its built-in email functionality - or your Amazon SES email configuration. Specify one of the following values: - -
COGNITO_DEFAULT
- - When Amazon Cognito emails your users, it uses its built-in email functionality. When - you use the default option, Amazon Cognito allows only a limited number of emails - each day for your user pool. For typical production environments, the default email - limit is below the required delivery volume. To achieve a higher delivery volume, - specify DEVELOPER to use your Amazon SES email configuration. - - - - To look up the email delivery limit for the default option, see Limits - in Amazon Cognito in the Amazon Cognito Developer Guide. - - - - The default FROM address is no-reply@verificationemail.com. To customize the FROM - address, provide the ARN of an Amazon SES verified email address for the SourceArn - parameter. - - - - If EmailSendingAccount is COGNITO_DEFAULT, the following parameters aren't allowed: - -
  • - - EmailVerificationMessage - -
  • - - EmailVerificationSubject - -
  • - - InviteMessageTemplate.EmailMessage - -
  • - - InviteMessageTemplate.EmailSubject - -
  • - - VerificationMessageTemplate.EmailMessage - -
  • - - VerificationMessageTemplate.EmailMessageByLink - -
  • - - VerificationMessageTemplate.EmailSubject, - -
  • - - VerificationMessageTemplate.EmailSubjectByLink - -
- - DEVELOPER EmailSendingAccount is required. - -
DEVELOPER
- - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon - Cognito calls Amazon SES on your behalf to send email from your verified email address. - When you use this option, the email delivery limits are the same limits that apply - to your Amazon SES verified email address in your AWS account. - - - - If you use this option, you must provide the ARN of an Amazon SES verified email address - for the SourceArn parameter. - - - - Before Amazon Cognito can email your users, it requires additional permissions to - call Amazon SES on your behalf. When you update your user pool with this option, Amazon - Cognito creates a service-linked role, which is a type of IAM role, in your - AWS account. This role contains the permissions that allow Amazon Cognito to access - Amazon SES and send email messages with your address. For more information about the - service-linked role that Amazon Cognito creates, see Using - Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide. - -
- - - - - Gets and sets the property From. - - Identifies either the sender’s email address or the sender’s name with their email - address. For example, testuser@example.com or Test User <testuser@example.com>. - This address will appear before the body of the email. - - - - - - Gets and sets the property ReplyToEmailAddress. - - The destination to which the receiver of the email should reply to. - - - - - - Gets and sets the property SourceArn. - - The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email - address is used in one of the following ways, depending on the value that you specify - for the EmailSendingAccount parameter: - -
  • - - If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the - custom FROM address when it emails your users by using its built-in email account. - -
  • - - If you specify DEVELOPER, Amazon Cognito emails your users with this - address by calling Amazon SES on your behalf. - -
- - - - - This exception is thrown when there is a code mismatch and the service fails to configure - the software token TOTP multi-factor authentication (MFA). - - - - - Constructs a new EnableSoftwareTokenMFAException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of EnableSoftwareTokenMFAException - - - - - - - Construct instance of EnableSoftwareTokenMFAException - - - - - - Construct instance of EnableSoftwareTokenMFAException - - - - - - - - - - - Construct instance of EnableSoftwareTokenMFAException - - - - - - - - - - Constructs a new instance of the EnableSoftwareTokenMFAException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Specifies the user context data captured at the time of an event request. - - - - - Gets and sets the property City. - - The user's city. - - - - - - Gets and sets the property Country. - - The user's country. - - - - - - Gets and sets the property DeviceName. - - The user's device name. - - - - - - Gets and sets the property IpAddress. - - The user's IP address. - - - - - - Gets and sets the property Timezone. - - The user's time zone. - - - - - - Specifies the event feedback type. - - - - - Gets and sets the property FeedbackDate. - - The event feedback date. - - - - - - Gets and sets the property FeedbackValue. - - The event feedback value. - - - - - - Gets and sets the property Provider. - - The provider. - - - - - - The event risk type. - - - - - Gets and sets the property CompromisedCredentialsDetected. - - Indicates whether compromised credentials were detected during an authentication event. - - - - - - Gets and sets the property RiskDecision. - - The risk decision. - - - - - - Gets and sets the property RiskLevel. - - The risk level. - - - - - - This exception is thrown if a code has expired. - - - - - Constructs a new ExpiredCodeException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ExpiredCodeException - - - - - - - Construct instance of ExpiredCodeException - - - - - - Construct instance of ExpiredCodeException - - - - - - - - - - - Construct instance of ExpiredCodeException - - - - - - - - - - Constructs a new instance of the ExpiredCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the ForgetDevice operation. - Forgets the specified device. - - - - - Gets and sets the property AccessToken. - - The access token for the forgotten device request. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - This is the response object from the ForgetDevice operation. - - - - - Container for the parameters to the ForgotPassword operation. - Calling this API causes a message to be sent to the end user with a confirmation code - that is required to change the user's password. For the Username parameter, - you can use the username or user alias. The method used to send the confirmation code - is sent according to the specified AccountRecoverySetting. For more information, see - Recovering - User Accounts in the Amazon Cognito Developer Guide. If neither a verified - phone number nor a verified email exists, an InvalidParameterException - is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword - calls. - - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the ForgotPassword API action, Amazon Cognito invokes any functions that - are assigned to the following triggers: pre sign-up, custom message, - and user migration. When Amazon Cognito invokes any of these functions, it - passes a JSON payload, which the function receives as input. This payload contains - a clientMetadata attribute, which provides the data that you assigned - to the ClientMetadata parameter in your ForgotPassword request. In your function code - in AWS Lambda, you can process the clientMetadata value to enhance your - workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property SecretHash. - - A keyed-hash message authentication code (HMAC) calculated using the secret key of - a user pool client and username plus the client ID in the message. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Username. - - The user name of the user for whom you want to enter a code to reset a forgotten password. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Respresents the response from the server regarding the request to reset a password. - - - - - Gets and sets the property CodeDeliveryDetails. - - The code delivery details returned by the server in response to the request to reset - a password. - - - - - - Container for the parameters to the GetCSVHeader operation. - Gets the header information for the .csv file to be used as input for the user import - job. - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are to be imported into. - - - - - - Represents the response from the server to the request to get the header information - for the .csv file for the user import job. - - - - - Gets and sets the property CSVHeader. - - The header information for the .csv file for the user import job. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are to be imported into. - - - - - - Container for the parameters to the GetDevice operation. - Gets the device. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets the device response. - - - - - Gets and sets the property Device. - - The device. - - - - - - Container for the parameters to the GetGroup operation. - Gets a group. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property GroupName. - - The name of the group. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the GetGroup operation. - - - - - Gets and sets the property Group. - - The group object for the group. - - - - - - Container for the parameters to the GetIdentityProviderByIdentifier operation. - Gets the specified identity provider. - - - - - Gets and sets the property IdpIdentifier. - - The identity provider ID. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the GetIdentityProviderByIdentifier operation. - - - - - Gets and sets the property IdentityProvider. - - The identity provider object. - - - - - - Container for the parameters to the GetSigningCertificate operation. - This method takes a user pool ID, and returns the signing certificate. - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - Response from Cognito for a signing certificate request. - - - - - Gets and sets the property Certificate. - - The signing certificate. - - - - - - Container for the parameters to the GetUICustomization operation. - Gets the UI Customization information for a particular app client's app UI, if there - is something set. If nothing is set for the particular client, but there is an existing - pool level customization (app clientId will be ALL), then - that is returned. If nothing is present, then an empty shape is returned. - - - - - Gets and sets the property ClientId. - - The client ID for the client app. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the GetUICustomization operation. - - - - - Gets and sets the property UICustomization. - - The UI customization information. - - - - - - Container for the parameters to the GetUserAttributeVerificationCode operation. - Gets the user attribute verification code for the specified attribute name. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AccessToken. - - The access token returned by the server response to get the user attribute verification - code. - - - - - - Gets and sets the property AttributeName. - - The attribute name returned by the server response to get the user attribute verification - code. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes - the function that is assigned to the custom message trigger. When Amazon Cognito - invokes this function, it passes a JSON payload, which the function receives as input. - This payload contains a clientMetadata attribute, which provides the - data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode - request. In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Get the signer to use for this request. - - A signer for this request. - - - - The verification code response returned by the server response to get the user attribute - verification code. - - - - - Gets and sets the property CodeDeliveryDetails. - - The code delivery details returned by the server in response to the request to get - the user attribute verification code. - - - - - - Container for the parameters to the GetUserPoolMfaConfig operation. - Gets the user pool multi-factor authentication (MFA) configuration. - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the GetUserPoolMfaConfig operation. - - - - - Gets and sets the property MfaConfiguration. - - The multi-factor (MFA) configuration. Valid values include: - -
  • - - OFF MFA will not be used for any users. - -
  • - - ON MFA is required for all users to sign in. - -
  • - - OPTIONAL MFA will be required only for individual users who have an - MFA factor enabled. - -
- - - - - Gets and sets the property SmsMfaConfiguration. - - The SMS text message multi-factor (MFA) configuration. - - - - - - Gets and sets the property SoftwareTokenMfaConfiguration. - - The software token multi-factor (MFA) configuration. - - - - - - Container for the parameters to the GetUser operation. - Gets the user attributes and metadata for a user. - - - - - Gets and sets the property AccessToken. - - The access token returned by the server response to get information about the user. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Represents the response from the server from the request to get information about - the user. - - - - - Gets and sets the property MFAOptions. - - This response parameter is no longer supported. It provides information only - about SMS MFA configurations. It doesn't provide information about TOTP software token - MFA configurations. To look up information about either type of MFA configuration, - use UserMFASettingList instead. - - - - - - Gets and sets the property PreferredMfaSetting. - - The user's preferred MFA setting. - - - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs representing user attributes. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Gets and sets the property UserMFASettingList. - - The MFA options that are enabled for the user. The possible values in this list are - SMS_MFA and SOFTWARE_TOKEN_MFA. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to retrieve from the get user request. - - - - - - Container for the parameters to the GlobalSignOut operation. - Signs out users from all devices. It also invalidates all refresh tokens issued to - a user. The user's current access and Id tokens remain valid until their expiry. Access - and Id tokens expire one hour after they are issued. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - The response to the request to sign out all devices. - - - - - This exception is thrown when Amazon Cognito encounters a group that already exists - in the user pool. - - - - - Constructs a new GroupExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of GroupExistsException - - - - - - - Construct instance of GroupExistsException - - - - - - Construct instance of GroupExistsException - - - - - - - - - - - Construct instance of GroupExistsException - - - - - - - - - - Constructs a new instance of the GroupExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The group type. - - - - - Gets and sets the property CreationDate. - - The date the group was created. - - - - - - Gets and sets the property Description. - - A string containing the description of the group. - - - - - - Gets and sets the property GroupName. - - The name of the group. - - - - - - Gets and sets the property LastModifiedDate. - - The date the group was last modified. - - - - - - Gets and sets the property Precedence. - - A nonnegative integer value that specifies the precedence of this group relative to - the other groups that a user can belong to in the user pool. If a user belongs to - two or more groups, it is the group with the highest precedence whose role ARN will - be used in the cognito:roles and cognito:preferred_role - claims in the user's tokens. Groups with higher Precedence values take - precedence over groups with lower Precedence values or with null Precedence - values. - - - - Two groups can have the same Precedence value. If this happens, neither - group takes precedence over the other. If two groups with the same Precedence - have the same role ARN, that role is used in the cognito:preferred_role - claim in tokens for users in each group. If the two groups have different role ARNs, - the cognito:preferred_role claim is not set in users' tokens. - - - - The default Precedence value is null. - - - - - - Gets and sets the property RoleArn. - - The role ARN for the group. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - The HTTP header. - - - - - Gets and sets the property HeaderName. - - The header name - - - - - - Gets and sets the property HeaderValue. - - The header value. - - - - - - A container for information about an identity provider. - - - - - Gets and sets the property AttributeMapping. - - A mapping of identity provider attributes to standard and custom user pool attributes. - - - - - - Gets and sets the property CreationDate. - - The date the identity provider was created. - - - - - - Gets and sets the property IdpIdentifiers. - - A list of identity provider identifiers. - - - - - - Gets and sets the property LastModifiedDate. - - The date the identity provider was last modified. - - - - - - Gets and sets the property ProviderDetails. - - The identity provider details. The following list describes the provider detail keys - for each identity provider type. - -
  • - - For Google and Login with Amazon: - -
    • - - client_id - -
    • - - client_secret - -
    • - - authorize_scopes - -
  • - - For Facebook: - -
    • - - client_id - -
    • - - client_secret - -
    • - - authorize_scopes - -
    • - - api_version - -
  • - - For Sign in with Apple: - -
    • - - client_id - -
    • - - team_id - -
    • - - key_id - -
    • - - private_key - -
    • - - authorize_scopes - -
  • - - For OIDC providers: - -
    • - - client_id - -
    • - - client_secret - -
    • - - attributes_request_method - -
    • - - oidc_issuer - -
    • - - authorize_scopes - -
    • - - authorize_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - token_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - attributes_url if not available from discovery URL specified by oidc_issuer key - - -
    • - - jwks_uri if not available from discovery URL specified by oidc_issuer key - -
  • - - For SAML providers: - -
    • - - MetadataFile OR MetadataURL - -
    • - - IDPSignOut optional - -
- - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property ProviderType. - - The identity provider type. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - Container for the parameters to the InitiateAuth operation. - Initiates the authentication flow. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth - calls. - - - - - - Gets and sets the property AuthFlow. - - The authentication flow for this call to execute. The API action will depend on this - value. For example: - -
  • - - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new - tokens. - -
  • - - USER_SRP_AUTH will take in USERNAME and SRP_A - and return the SRP variables to be used for next challenge execution. - -
  • - - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD - and return the next challenge or tokens. - -
- - Valid values include: - -
  • - - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) - protocol. - -
  • - - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for - refreshing the access token and ID token by supplying a valid refresh token. - -
  • - - CUSTOM_AUTH: Custom authentication flow. - -
  • - - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD - are passed directly. If a user migration Lambda trigger is set, this flow will invoke - the user migration Lambda if the USERNAME is not found in the user pool. - -
  • - - ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. - This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, - Cognito receives the password in the request instead of using the SRP process to verify - passwords. - -
- - ADMIN_NO_SRP_AUTH is not a valid value. - - - - - - Gets and sets the property AuthParameters. - - The authentication parameters. These are inputs corresponding to the AuthFlow - that you are invoking. The required values depend on the value of AuthFlow: - -
  • - - For USER_SRP_AUTH: USERNAME (required), SRP_A - (required), SECRET_HASH (required if the app client is configured with - a client secret), DEVICE_KEY. - -
  • - - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), - SECRET_HASH (required if the app client is configured with a client secret), - DEVICE_KEY. - -
  • - - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH - (if app client is configured with client secret), DEVICE_KEY. To start - the authentication flow with password verification, include ChallengeName: SRP_A - and SRP_A: (The SRP_A Value). - -
- - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for certain custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions - that are specified for various triggers. The ClientMetadata value is passed as input - to the functions for only the following triggers: - -
  • - - Pre signup - -
  • - - Pre authentication - -
  • - - User migration - -
- - When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, - which the function receives as input. This payload contains a validationData - attribute, which provides the data that you assigned to the ClientMetadata parameter - in your InitiateAuth request. In your function code in AWS Lambda, you can process - the validationData value to enhance your workflow for your specific needs. - - - - When you use the InitiateAuth API action, Amazon Cognito also invokes the functions - for the following triggers, but it does not provide the ClientMetadata value as input: - -
  • - - Post authentication - -
  • - - Custom message - -
  • - - Pre token generation - -
  • - - Create auth challenge - -
  • - - Define auth challenge - -
  • - - Verify auth challenge - -
- - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Initiates the authentication response. - - - - - Gets and sets the property AuthenticationResult. - - The result of the authentication response. This is only returned if the caller does - not need to pass another challenge. If the caller does need to pass another challenge - before it gets tokens, ChallengeName, ChallengeParameters, - and Session are returned. - - - - - - Gets and sets the property ChallengeName. - - The name of the challenge which you are responding to with this call. This is returned - to you in the AdminInitiateAuth response if you need to pass another - challenge. - - - - Valid values include the following. Note that all of these challenges require USERNAME - and SECRET_HASH (if applicable) in the parameters. - -
  • - - SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered - via SMS. - -
  • - - PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, - PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side - SRP calculations. - -
  • - - CUSTOM_CHALLENGE: This is returned if your custom authentication flow - determines that the user should pass another challenge before tokens are issued. - -
  • - - DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and - the previous challenges were passed, this challenge is returned so that Amazon Cognito - can start tracking this device. - -
  • - - DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, - but for devices only. - -
  • - - NEW_PASSWORD_REQUIRED: For users who are required to change their passwords - after successful first login. This challenge should be passed with NEW_PASSWORD - and any other required attributes. - -
  • - - MFA_SETUP: For users who are required to setup an MFA factor before - they can sign-in. The MFA types enabled for the user pool will be listed in the challenge - parameters MFA_CAN_SETUP value. - - - - To setup software token MFA, use the session returned here from InitiateAuth - as an input to AssociateSoftwareToken, and use the session returned by - VerifySoftwareToken as an input to RespondToAuthChallenge - with challenge name MFA_SETUP to complete sign-in. To setup SMS MFA, - users will need help from an administrator to add a phone number to their account - and then call InitiateAuth again to restart sign-in. - -
- - - - - Gets and sets the property ChallengeParameters. - - The challenge parameters. These are returned to you in the InitiateAuth - response if you need to pass another challenge. The responses in this parameter should - be used to compute inputs to the next call (RespondToAuthChallenge). - - - - - All challenges require USERNAME and SECRET_HASH (if applicable). - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If the caller needs to go through another challenge, they return a session with other - challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge - API call. - - - - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - - - Constructs a new InternalErrorException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InternalErrorException - - - - - - - Construct instance of InternalErrorException - - - - - - Construct instance of InternalErrorException - - - - - - - - - - - Construct instance of InternalErrorException - - - - - - - - - - Constructs a new instance of the InternalErrorException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - AccountRecoverySettingType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AccountRecoverySettingType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AccountTakeoverActionsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AccountTakeoverActionsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AccountTakeoverActionType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AccountTakeoverActionType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AccountTakeoverRiskConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AccountTakeoverRiskConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AddCustomAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AddCustomAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminAddUserToGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminAddUserToGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminConfirmSignUp Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminConfirmSignUp operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminCreateUserConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AdminCreateUserConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AdminCreateUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminCreateUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminDeleteUserAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminDeleteUserAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminDeleteUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminDeleteUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminDisableProviderForUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminDisableProviderForUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminDisableUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminDisableUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminEnableUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminEnableUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminForgetDevice Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminForgetDevice operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminGetDevice Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminGetDevice operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminGetUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminGetUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminInitiateAuth Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminInitiateAuth operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminLinkProviderForUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminLinkProviderForUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminListDevices Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminListDevices operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminListGroupsForUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminListGroupsForUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminListUserAuthEvents Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminListUserAuthEvents operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminRemoveUserFromGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminRemoveUserFromGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminResetUserPassword Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminResetUserPassword operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminRespondToAuthChallenge Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminRespondToAuthChallenge operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminSetUserMFAPreference Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminSetUserMFAPreference operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminSetUserPassword Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminSetUserPassword operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminSetUserSettings Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminSetUserSettings operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminUpdateAuthEventFeedback Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminUpdateAuthEventFeedback operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminUpdateDeviceStatus Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminUpdateDeviceStatus operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminUpdateUserAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminUpdateUserAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AdminUserGlobalSignOut Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AdminUserGlobalSignOut operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AliasExistsException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - AnalyticsConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AnalyticsConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AnalyticsMetadataType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - AssociateSoftwareToken Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AssociateSoftwareToken operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AttributeType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AttributeType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AuthenticationResultType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AuthEventType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ChallengeResponseType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - ChangePassword Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ChangePassword operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CodeDeliveryDetailsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CodeDeliveryFailureException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CodeMismatchException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - CompromisedCredentialsActionsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CompromisedCredentialsActionsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - CompromisedCredentialsRiskConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CompromisedCredentialsRiskConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ConcurrentModificationException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - ConfirmDevice Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ConfirmDevice operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ConfirmForgotPassword Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ConfirmForgotPassword operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ConfirmSignUp Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ConfirmSignUp operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ContextDataType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - CreateGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateIdentityProvider Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateIdentityProvider operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateResourceServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateResourceServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateUserImportJob Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateUserImportJob operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateUserPoolClient Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateUserPoolClient operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateUserPoolDomain Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateUserPoolDomain operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateUserPool Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateUserPool operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CustomDomainConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CustomDomainConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - CustomEmailLambdaVersionConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CustomEmailLambdaVersionConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - CustomSMSLambdaVersionConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CustomSMSLambdaVersionConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - DeleteGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteIdentityProvider Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteIdentityProvider operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteResourceServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteResourceServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteUserAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteUserAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteUserPoolClient Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteUserPoolClient operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteUserPoolDomain Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteUserPoolDomain operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteUserPool Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteUserPool operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeIdentityProvider Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeIdentityProvider operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeResourceServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeResourceServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeRiskConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeRiskConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeUserImportJob Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeUserImportJob operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeUserPoolClient Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeUserPoolClient operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeUserPoolDomain Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeUserPoolDomain operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeUserPool Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeUserPool operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeviceConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for DeviceConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - DeviceSecretVerifierConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for DeviceType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DomainDescriptionType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DuplicateProviderException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - EmailConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for EmailConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EnableSoftwareTokenMFAException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EventContextDataType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EventFeedbackType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EventRiskType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ExpiredCodeException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - ForgetDevice Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ForgetDevice operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ForgotPassword Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ForgotPassword operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetCSVHeader Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetCSVHeader operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetDevice Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetDevice operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetIdentityProviderByIdentifier Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetIdentityProviderByIdentifier operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetSigningCertificate Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetSigningCertificate operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetUICustomization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetUICustomization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetUserAttributeVerificationCode Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetUserAttributeVerificationCode operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetUserPoolMfaConfig Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetUserPoolMfaConfig operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetUser Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetUser operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GlobalSignOut Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GlobalSignOut operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GroupExistsException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GroupType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - HttpHeader Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for IdentityProviderType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - InitiateAuth Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InitiateAuth operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InternalErrorException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidEmailRoleAccessPolicyException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidLambdaResponseException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidOAuthFlowException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidParameterException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidPasswordException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidSmsRoleAccessPolicyException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidSmsRoleTrustRelationshipException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidUserPoolConfigurationException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - LambdaConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for LambdaConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for LimitExceededException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - ListDevices Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListDevices operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListGroups Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListGroups operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListIdentityProviders Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListIdentityProviders operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListResourceServers Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListResourceServers operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListTagsForResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListTagsForResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListUserImportJobs Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListUserImportJobs operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListUserPoolClients Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListUserPoolClients operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListUserPools Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListUserPools operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListUsersInGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListUsersInGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListUsers Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListUsers operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - MessageTemplateType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for MessageTemplateType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MFAMethodNotFoundException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - MFAOptionType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for MFAOptionType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for NewDeviceMetadataType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for NotAuthorizedException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - NotifyConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for NotifyConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - NotifyEmailType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for NotifyEmailType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - NumberAttributeConstraintsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for NumberAttributeConstraintsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PasswordPolicyType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for PasswordPolicyType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PasswordResetRequiredException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PreconditionNotMetException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ProviderDescription Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - ProviderUserIdentifierType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - RecoveryOptionType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for RecoveryOptionType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - ResendConfirmationCode Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResendConfirmationCode operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceNotFoundException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - ResourceServerScopeType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for ResourceServerScopeType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResourceServerType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - RespondToAuthChallenge Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RespondToAuthChallenge operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RevokeToken Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RevokeToken operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RiskConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - RiskExceptionConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for RiskExceptionConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - SchemaAttributeType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for SchemaAttributeType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ScopeDoesNotExistException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - SetRiskConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetRiskConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetUICustomization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetUICustomization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetUserMFAPreference Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetUserMFAPreference operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetUserPoolMfaConfig Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetUserPoolMfaConfig operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SetUserSettings Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SetUserSettings operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SignUp Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SignUp operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SmsConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for SmsConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - SmsMfaConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for SmsMfaConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - SMSMfaSettingsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - SoftwareTokenMfaConfigType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for SoftwareTokenMfaConfigType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SoftwareTokenMFANotFoundException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - SoftwareTokenMfaSettingsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - StartUserImportJob Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StartUserImportJob operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StopUserImportJob Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StopUserImportJob operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StringAttributeConstraintsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for StringAttributeConstraintsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - TagResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TagResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - TokenValidityUnitsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for TokenValidityUnitsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TooManyFailedAttemptsException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TooManyRequestsException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UICustomizationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnauthorizedException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnexpectedLambdaException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnsupportedIdentityProviderException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnsupportedOperationException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnsupportedTokenTypeException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnsupportedUserStateException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - UntagResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UntagResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateAuthEventFeedback Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateAuthEventFeedback operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateDeviceStatus Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateDeviceStatus operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateIdentityProvider Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateIdentityProvider operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateResourceServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateResourceServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateUserAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateUserAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateUserPoolClient Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateUserPoolClient operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateUserPoolDomain Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateUserPoolDomain operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateUserPool Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateUserPool operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UserContextDataType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for UserImportInProgressException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserImportJobType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserLambdaValidationException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - UsernameConfigurationType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for UsernameConfigurationType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UsernameExistsException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserNotConfirmedException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserNotFoundException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolAddOnNotEnabledException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - UserPoolAddOnsType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for UserPoolAddOnsType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolClientDescription Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolClientType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolDescriptionType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - UserPoolPolicyType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for UserPoolPolicyType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolTaggingException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserPoolType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UserType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - VerificationMessageTemplateType Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for VerificationMessageTemplateType Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - VerifySoftwareToken Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for VerifySoftwareToken operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - VerifyUserAttribute Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for VerifyUserAttribute operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - - - Constructs a new InvalidEmailRoleAccessPolicyException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidEmailRoleAccessPolicyException - - - - - - - Construct instance of InvalidEmailRoleAccessPolicyException - - - - - - Construct instance of InvalidEmailRoleAccessPolicyException - - - - - - - - - - - Construct instance of InvalidEmailRoleAccessPolicyException - - - - - - - - - - Constructs a new instance of the InvalidEmailRoleAccessPolicyException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - - - Constructs a new InvalidLambdaResponseException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidLambdaResponseException - - - - - - - Construct instance of InvalidLambdaResponseException - - - - - - Construct instance of InvalidLambdaResponseException - - - - - - - - - - - Construct instance of InvalidLambdaResponseException - - - - - - - - - - Constructs a new instance of the InvalidLambdaResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the specified OAuth flow is invalid. - - - - - Constructs a new InvalidOAuthFlowException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidOAuthFlowException - - - - - - - Construct instance of InvalidOAuthFlowException - - - - - - Construct instance of InvalidOAuthFlowException - - - - - - - - - - - Construct instance of InvalidOAuthFlowException - - - - - - - - - - Constructs a new instance of the InvalidOAuthFlowException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - - - Constructs a new InvalidParameterException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidParameterException - - - - - - - Construct instance of InvalidParameterException - - - - - - Construct instance of InvalidParameterException - - - - - - - - - - - Construct instance of InvalidParameterException - - - - - - - - - - Constructs a new instance of the InvalidParameterException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - - - Constructs a new InvalidPasswordException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidPasswordException - - - - - - - Construct instance of InvalidPasswordException - - - - - - Construct instance of InvalidPasswordException - - - - - - - - - - - Construct instance of InvalidPasswordException - - - - - - - - - - Constructs a new instance of the InvalidPasswordException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - - - Constructs a new InvalidSmsRoleAccessPolicyException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidSmsRoleAccessPolicyException - - - - - - - Construct instance of InvalidSmsRoleAccessPolicyException - - - - - - Construct instance of InvalidSmsRoleAccessPolicyException - - - - - - - - - - - Construct instance of InvalidSmsRoleAccessPolicyException - - - - - - - - - - Constructs a new instance of the InvalidSmsRoleAccessPolicyException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - - - Constructs a new InvalidSmsRoleTrustRelationshipException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidSmsRoleTrustRelationshipException - - - - - - - Construct instance of InvalidSmsRoleTrustRelationshipException - - - - - - Construct instance of InvalidSmsRoleTrustRelationshipException - - - - - - - - - - - Construct instance of InvalidSmsRoleTrustRelationshipException - - - - - - - - - - Constructs a new instance of the InvalidSmsRoleTrustRelationshipException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the user pool configuration is invalid. - - - - - Constructs a new InvalidUserPoolConfigurationException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidUserPoolConfigurationException - - - - - - - Construct instance of InvalidUserPoolConfigurationException - - - - - - Construct instance of InvalidUserPoolConfigurationException - - - - - - - - - - - Construct instance of InvalidUserPoolConfigurationException - - - - - - - - - - Constructs a new instance of the InvalidUserPoolConfigurationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Specifies the configuration for AWS Lambda triggers. - - - - - Gets and sets the property CreateAuthChallenge. - - Creates an authentication challenge. - - - - - - Gets and sets the property CustomEmailSender. - - A custom email sender AWS Lambda trigger. - - - - - - Gets and sets the property CustomMessage. - - A custom Message AWS Lambda trigger. - - - - - - Gets and sets the property CustomSMSSender. - - A custom SMS sender AWS Lambda trigger. - - - - - - Gets and sets the property DefineAuthChallenge. - - Defines the authentication challenge. - - - - - - Gets and sets the property KMSKeyID. - - The Amazon Resource Name of Key Management Service Customer - master keys . Amazon Cognito uses the key to encrypt codes and temporary passwords - sent to CustomEmailSender and CustomSMSSender. - - - - - - Gets and sets the property PostAuthentication. - - A post-authentication AWS Lambda trigger. - - - - - - Gets and sets the property PostConfirmation. - - A post-confirmation AWS Lambda trigger. - - - - - - Gets and sets the property PreAuthentication. - - A pre-authentication AWS Lambda trigger. - - - - - - Gets and sets the property PreSignUp. - - A pre-registration AWS Lambda trigger. - - - - - - Gets and sets the property PreTokenGeneration. - - A Lambda trigger that is invoked before token generation. - - - - - - Gets and sets the property UserMigration. - - The user migration Lambda config type. - - - - - - Gets and sets the property VerifyAuthChallengeResponse. - - Verifies the authentication challenge response. - - - - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - - - Constructs a new LimitExceededException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of LimitExceededException - - - - - - - Construct instance of LimitExceededException - - - - - - Construct instance of LimitExceededException - - - - - - - - - - - Construct instance of LimitExceededException - - - - - - - - - - Constructs a new instance of the LimitExceededException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the ListDevices operation. - Lists the devices. - - - - - Gets and sets the property AccessToken. - - The access tokens for the request to list devices. - - - - - - Gets and sets the property Limit. - - The limit of the device request. - - - - - - Gets and sets the property PaginationToken. - - The pagination token for the list request. - - - - - - Represents the response to list devices. - - - - - Gets and sets the property Devices. - - The devices returned in the list devices response. - - - - - - Gets and sets the property PaginationToken. - - The pagination token for the list device response. - - - - - - Container for the parameters to the ListGroups operation. - Lists the groups associated with a user pool. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property Limit. - - The limit of the request to list groups. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the ListGroups operation. - - - - - Gets and sets the property Groups. - - The group objects for the groups. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Container for the parameters to the ListIdentityProviders operation. - Lists information about all identity providers for a user pool. - - - - - Gets and sets the property MaxResults. - - The maximum number of identity providers to return. - - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the ListIdentityProviders operation. - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Gets and sets the property Providers. - - A list of identity provider objects. - - - - - - Container for the parameters to the ListResourceServers operation. - Lists the resource servers for a user pool. - - - - - Gets and sets the property MaxResults. - - The maximum number of resource servers to return. - - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the ListResourceServers operation. - - - - - Gets and sets the property NextToken. - - A pagination token. - - - - - - Gets and sets the property ResourceServers. - - The resource servers. - - - - - - Container for the parameters to the ListTagsForResource operation. - Lists the tags that are assigned to an Amazon Cognito user pool. - - - - A tag is a label that you can apply to user pools to categorize and manage them in - different ways, such as by purpose, owner, environment, or other criteria. - - - - You can use this action up to 10 times per second, per account. - - - - - - Gets and sets the property ResourceArn. - - The Amazon Resource Name (ARN) of the user pool that the tags are assigned to. - - - - - - This is the response object from the ListTagsForResource operation. - - - - - Gets and sets the property Tags. - - The tags that are assigned to the user pool. - - - - - - Container for the parameters to the ListUserImportJobs operation. - Lists the user import jobs. - - - - - Gets and sets the property MaxResults. - - The maximum number of import jobs you want the request to return. - - - - - - Gets and sets the property PaginationToken. - - An identifier that was returned from the previous call to ListUserImportJobs, - which can be used to return the next set of import jobs in the list. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - Represents the response from the server to the request to list the user import jobs. - - - - - Gets and sets the property PaginationToken. - - An identifier that can be used to return the next set of user import jobs in the list. - - - - - - Gets and sets the property UserImportJobs. - - The user import jobs. - - - - - - Container for the parameters to the ListUserPoolClients operation. - Lists the clients that have been created for the specified user pool. - - - - - Gets and sets the property MaxResults. - - The maximum number of results you want the request to return when listing the user - pool clients. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to list user pool clients. - - - - - - Represents the response from the server that lists user pool clients. - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPoolClients. - - The user pool clients in the response that lists user pool clients. - - - - - - Container for the parameters to the ListUserPools operation. - Lists the user pools associated with an AWS account. - - - - - Gets and sets the property MaxResults. - - The maximum number of results you want the request to return when listing the user - pools. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Represents the response to list user pools. - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPools. - - The user pools from the response to list users. - - - - - - Container for the parameters to the ListUsersInGroup operation. - Lists the users in the specified group. - - - - Calling this action requires developer credentials. - - - - - - Gets and sets the property GroupName. - - The name of the group. - - - - - - Gets and sets the property Limit. - - The limit of the request to list users. - - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the ListUsersInGroup operation. - - - - - Gets and sets the property NextToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property Users. - - The users returned in the request to list users. - - - - - - Container for the parameters to the ListUsers operation. - Lists the users in the Amazon Cognito user pool. - - - - - Gets and sets the property AttributesToGet. - - An array of strings, where each string is the name of a user attribute to be returned - for each user in the search results. If the array is null, all attributes are returned. - - - - - - Gets and sets the property Filter. - - A filter string of the form "AttributeName Filter-Type "AttributeValue"". - Quotation marks within the filter string must be escaped using the backslash (\) character. - For example, "family_name = \"Reddy\"". - -
  • - - AttributeName: The name of the attribute to search for. You can only search - for one attribute at a time. - -
  • - - Filter-Type: For an exact match, use =, for example, "given_name - = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name - ^= \"Jon\"". - -
  • - - AttributeValue: The attribute value that must be matched for each user. - -
- - If the filter string is empty, ListUsers returns all users in the user - pool. - - - - You can only search for the following standard attributes: - -
  • - - username (case-sensitive) - -
  • - - email - -
  • - - phone_number - -
  • - - name - -
  • - - given_name - -
  • - - family_name - -
  • - - preferred_username - -
  • - - cognito:user_status (called Status in the Console) (case-insensitive) - -
  • - - status (called Enabled in the Console) (case-sensitive) - -
  • - - sub - -
- - Custom attributes are not searchable. - - - - For more information, see Searching - for Users Using the ListUsers API and Examples - of Using the ListUsers API in the Amazon Cognito Developer Guide. - - - - - - Gets and sets the property Limit. - - Maximum number of users to be returned. - - - - - - Gets and sets the property PaginationToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool on which the search should be performed. - - - - - - The response from the request to list users. - - - - - Gets and sets the property PaginationToken. - - An identifier that was returned from the previous call to this operation, which can - be used to return the next set of items in the list. - - - - - - Gets and sets the property Users. - - The users returned in the request to list users. - - - - - - The message template structure. - - - - - Gets and sets the property EmailMessage. - - The message template for email messages. EmailMessage is allowed only if EmailSendingAccount - is DEVELOPER. - - - - - - Gets and sets the property EmailSubject. - - The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount - is DEVELOPER. - - - - - - Gets and sets the property SMSMessage. - - The message template for SMS messages. - - - - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - - - Constructs a new MFAMethodNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of MFAMethodNotFoundException - - - - - - - Construct instance of MFAMethodNotFoundException - - - - - - Construct instance of MFAMethodNotFoundException - - - - - - - - - - - Construct instance of MFAMethodNotFoundException - - - - - - - - - - Constructs a new instance of the MFAMethodNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This data type is no longer supported. You can use it only for SMS MFA configurations. - You can't use it for TOTP software token MFA configurations. - - - - - Gets and sets the property AttributeName. - - The attribute name of the MFA option type. The only valid value is phone_number. - - - - - - Gets and sets the property DeliveryMedium. - - The delivery medium to send the MFA code. You can use this parameter to set only the - SMS delivery medium value. - - - - - - The new device metadata type. - - - - - Gets and sets the property DeviceGroupKey. - - The device group key. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - This exception is thrown when a user is not authorized. - - - - - Constructs a new NotAuthorizedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of NotAuthorizedException - - - - - - - Construct instance of NotAuthorizedException - - - - - - Construct instance of NotAuthorizedException - - - - - - - - - - - Construct instance of NotAuthorizedException - - - - - - - - - - Constructs a new instance of the NotAuthorizedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The notify configuration type. - - - - - Gets and sets the property BlockEmail. - - Email template used when a detected risk event is blocked. - - - - - - Gets and sets the property From. - - The email address that is sending the email. It must be either individually verified - with Amazon SES, or from a domain that has been verified with Amazon SES. - - - - - - Gets and sets the property MfaEmail. - - The MFA email template used when MFA is challenged as part of a detected risk. - - - - - - Gets and sets the property NoActionEmail. - - The email template used when a detected risk event is allowed. - - - - - - Gets and sets the property ReplyTo. - - The destination to which the receiver of an email should reply to. - - - - - - Gets and sets the property SourceArn. - - The Amazon Resource Name (ARN) of the identity that is associated with the sending - authorization policy. It permits Amazon Cognito to send for the email address specified - in the From parameter. - - - - - - The notify email type. - - - - - Gets and sets the property HtmlBody. - - The HTML body. - - - - - - Gets and sets the property Subject. - - The subject. - - - - - - Gets and sets the property TextBody. - - The text body. - - - - - - The minimum and maximum value of an attribute that is of the number data type. - - - - - Gets and sets the property MaxValue. - - The maximum value of an attribute that is of the number data type. - - - - - - Gets and sets the property MinValue. - - The minimum value of an attribute that is of the number data type. - - - - - - The password policy type. - - - - - Gets and sets the property MinimumLength. - - The minimum length of the password policy that you have set. Cannot be less than 6. - - - - - - Gets and sets the property RequireLowercase. - - In the password policy that you have set, refers to whether you have required users - to use at least one lowercase letter in their password. - - - - - - Gets and sets the property RequireNumbers. - - In the password policy that you have set, refers to whether you have required users - to use at least one number in their password. - - - - - - Gets and sets the property RequireSymbols. - - In the password policy that you have set, refers to whether you have required users - to use at least one symbol in their password. - - - - - - Gets and sets the property RequireUppercase. - - In the password policy that you have set, refers to whether you have required users - to use at least one uppercase letter in their password. - - - - - - Gets and sets the property TemporaryPasswordValidityDays. - - In the password policy you have set, refers to the number of days a temporary password - is valid. If the user does not sign-in during this time, their password will need - to be reset by an administrator. - - - - When you set TemporaryPasswordValidityDays for a user pool, you will - no longer be able to set the deprecated UnusedAccountValidityDays value - for that user pool. - - - - - - - This exception is thrown when a password reset is required. - - - - - Constructs a new PasswordResetRequiredException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of PasswordResetRequiredException - - - - - - - Construct instance of PasswordResetRequiredException - - - - - - Construct instance of PasswordResetRequiredException - - - - - - - - - - - Construct instance of PasswordResetRequiredException - - - - - - - - - - Constructs a new instance of the PasswordResetRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when a precondition is not met. - - - - - Constructs a new PreconditionNotMetException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of PreconditionNotMetException - - - - - - - Construct instance of PreconditionNotMetException - - - - - - Construct instance of PreconditionNotMetException - - - - - - - - - - - Construct instance of PreconditionNotMetException - - - - - - - - - - Constructs a new instance of the PreconditionNotMetException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A container for identity provider details. - - - - - Gets and sets the property CreationDate. - - The date the provider was added to the user pool. - - - - - - Gets and sets the property LastModifiedDate. - - The date the provider was last modified. - - - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property ProviderType. - - The identity provider type. - - - - - - A container for information about an identity provider for a user pool. - - - - - Gets and sets the property ProviderAttributeName. - - The name of the provider attribute to link to, for example, NameID. - - - - - - Gets and sets the property ProviderAttributeValue. - - The value of the provider attribute to link to, for example, xxxxx_account. - - - - - - Gets and sets the property ProviderName. - - The name of the provider, for example, Facebook, Google, or Login with Amazon. - - - - - - A map containing a priority as a key, and recovery method name as a value. - - - - - Gets and sets the property Name. - - Specifies the recovery method for a user. - - - - - - Gets and sets the property Priority. - - A positive integer specifying priority of a method with 1 being the highest priority. - - - - - - Container for the parameters to the ResendConfirmationCode operation. - Resends the confirmation (for confirmation of registration) to a specific user in - the user pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode - calls. - - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function - that is assigned to the custom message trigger. When Amazon Cognito invokes - this function, it passes a JSON payload, which the function receives as input. This - payload contains a clientMetadata attribute, which provides the data - that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. - In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property SecretHash. - - A keyed-hash message authentication code (HMAC) calculated using the secret key of - a user pool client and username plus the client ID in the message. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Username. - - The user name of the user to whom you wish to resend a confirmation code. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response from the server when the Amazon Cognito Your User Pools service makes - the request to resend a confirmation code. - - - - - Gets and sets the property CodeDeliveryDetails. - - The code delivery details returned by the server in response to the request to resend - the confirmation code. - - - - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - - - Constructs a new ResourceNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ResourceNotFoundException - - - - - - - Construct instance of ResourceNotFoundException - - - - - - Construct instance of ResourceNotFoundException - - - - - - - - - - - Construct instance of ResourceNotFoundException - - - - - - - - - - Constructs a new instance of the ResourceNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A resource server scope. - - - - - Gets and sets the property ScopeDescription. - - A description of the scope. - - - - - - Gets and sets the property ScopeName. - - The name of the scope. - - - - - - A container for information about a resource server for a user pool. - - - - - Gets and sets the property Identifier. - - The identifier for the resource server. - - - - - - Gets and sets the property Name. - - The name of the resource server. - - - - - - Gets and sets the property Scopes. - - A list of scopes that are defined for the resource server. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that hosts the resource server. - - - - - - Container for the parameters to the RespondToAuthChallenge operation. - Responds to the authentication challenge. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge - calls. - - - - - - Gets and sets the property ChallengeName. - - The challenge name. For more information, see InitiateAuth. - - - - ADMIN_NO_SRP_AUTH is not a valid value. - - - - - - Gets and sets the property ChallengeResponses. - - The challenge responses. These are inputs corresponding to the value of ChallengeName, - for example: - - - - SECRET_HASH (if app client is configured with client secret) applies - to all inputs below (including SOFTWARE_TOKEN_MFA). - -
  • - - SMS_MFA: SMS_MFA_CODE, USERNAME. - -
  • - - PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, - TIMESTAMP, USERNAME. - -
  • - - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required - attributes, USERNAME. - -
  • - - SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE - are required attributes. - -
  • - - DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, - SRP_A (and SECRET_HASH). - -
  • - - DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER - requires plus DEVICE_KEY. - -
  • - - MFA_SETUP requires USERNAME, plus you need to use the session - value returned by VerifySoftwareToken in the Session parameter. - -
- - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions - that are assigned to the following triggers: post authentication, pre token - generation, define auth challenge, create auth challenge, and verify - auth challenge. When Amazon Cognito invokes any of these functions, it passes - a JSON payload, which the function receives as input. This payload contains a clientMetadata - attribute, which provides the data that you assigned to the ClientMetadata parameter - in your RespondToAuthChallenge request. In your function code in AWS Lambda, you can - process the clientMetadata value to enhance your workflow for your specific - needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If InitiateAuth or RespondToAuthChallenge API call determines - that the caller needs to go through another challenge, they return a session with - other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge - API call. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response to respond to the authentication challenge. - - - - - Gets and sets the property AuthenticationResult. - - The result returned by the server in response to the request to respond to the authentication - challenge. - - - - - - Gets and sets the property ChallengeName. - - The challenge name. For more information, see InitiateAuth. - - - - - - Gets and sets the property ChallengeParameters. - - The challenge parameters. For more information, see InitiateAuth. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - If the caller needs to go through another challenge, they return a session with other - challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge - API call. - - - - - - Container for the parameters to the RevokeToken operation. - Revokes all of the access tokens generated by the specified refresh token. After the - token is revoked, you can not use the revoked token to access Cognito authenticated - APIs. - - - - - Gets and sets the property ClientId. - - The client ID for the token that you want to revoke. - - - - - - Gets and sets the property ClientSecret. - - The secret for the client ID. This is required only if the client ID has a secret. - - - - - - Gets and sets the property Token. - - The token that you want to revoke. - - - - - - This is the response object from the RevokeToken operation. - - - - - The risk configuration type. - - - - - Gets and sets the property AccountTakeoverRiskConfiguration. - - The account takeover risk configuration object including the NotifyConfiguration - object and Actions to take in the case of an account takeover. - - - - - - Gets and sets the property ClientId. - - The app client ID. - - - - - - Gets and sets the property CompromisedCredentialsRiskConfiguration. - - The compromised credentials risk configuration object including the EventFilter - and the EventAction - - - - - - Gets and sets the property LastModifiedDate. - - The last modified date. - - - - - - Gets and sets the property RiskExceptionConfiguration. - - The configuration to override the risk decision. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - The type of the configuration to override the risk decision. - - - - - Gets and sets the property BlockedIPRangeList. - - Overrides the risk decision to always block the pre-authentication requests. The IP - range is in CIDR notation: a compact representation of an IP address and its associated - routing prefix. - - - - - - Gets and sets the property SkippedIPRangeList. - - Risk detection is not performed on the IP addresses in the range list. The IP range - is in CIDR notation. - - - - - - Contains information about the schema attribute. - - - - - Gets and sets the property AttributeDataType. - - The attribute data type. - - - - - - Gets and sets the property DeveloperOnlyAttribute. - - We recommend that you use WriteAttributes - in the user pool client to control how attributes can be mutated for new use cases - instead of using DeveloperOnlyAttribute. - - - - Specifies whether the attribute type is developer only. This attribute can only be - modified by an administrator. Users will not be able to modify this attribute using - their access token. For example, DeveloperOnlyAttribute can be modified - using AdminUpdateUserAttributes but cannot be updated using UpdateUserAttributes. - - - - - - Gets and sets the property Mutable. - - Specifies whether the value of the attribute can be changed. - - - - For any user pool attribute that's mapped to an identity provider attribute, you must - set this parameter to true. Amazon Cognito updates mapped attributes - when users sign in to your application through an identity provider. If an attribute - is immutable, Amazon Cognito throws an error when it attempts to update the attribute. - For more information, see Specifying - Identity Provider Attribute Mappings for Your User Pool. - - - - - - Gets and sets the property Name. - - A schema attribute of the name type. - - - - - - Gets and sets the property NumberAttributeConstraints. - - Specifies the constraints for an attribute of the number type. - - - - - - Gets and sets the property Required. - - Specifies whether a user pool attribute is required. If the attribute is required - and the user does not provide a value, registration or sign-in will fail. - - - - - - Gets and sets the property StringAttributeConstraints. - - Specifies the constraints for an attribute of the string type. - - - - - - This exception is thrown when the specified scope does not exist. - - - - - Constructs a new ScopeDoesNotExistException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ScopeDoesNotExistException - - - - - - - Construct instance of ScopeDoesNotExistException - - - - - - Construct instance of ScopeDoesNotExistException - - - - - - - - - - - Construct instance of ScopeDoesNotExistException - - - - - - - - - - Constructs a new instance of the ScopeDoesNotExistException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the SetRiskConfiguration operation. - Configures actions on detected risks. To delete the risk configuration for UserPoolId - or ClientId, pass null values for all four configuration types. - - - - To enable Amazon Cognito advanced security features, update the user pool to include - the UserPoolAddOns keyAdvancedSecurityMode. - - - - - - Gets and sets the property AccountTakeoverRiskConfiguration. - - The account takeover risk configuration. - - - - - - Gets and sets the property ClientId. - - The app client ID. If ClientId is null, then the risk configuration is - mapped to userPoolId. When the client ID is null, the same risk configuration - is applied to all the clients in the userPool. - - - - Otherwise, ClientId is mapped to the client. When the client ID is not - null, the user pool configuration is overridden and the risk configuration for the - client is used instead. - - - - - - Gets and sets the property CompromisedCredentialsRiskConfiguration. - - The compromised credentials risk configuration. - - - - - - Gets and sets the property RiskExceptionConfiguration. - - The configuration to override the risk decision. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the SetRiskConfiguration operation. - - - - - Gets and sets the property RiskConfiguration. - - The risk configuration. - - - - - - Container for the parameters to the SetUICustomization operation. - Sets the UI customization information for a user pool's built-in app UI. - - - - You can specify app UI customization settings for a single client (with a specific - clientId) or for all clients (by setting the clientId to - ALL). If you specify ALL, the default configuration will - be used for every client that has no UI customization set previously. If you specify - UI customization settings for a particular client, it will no longer fall back to - the ALL configuration. - - - - To use this API, your user pool must have a domain associated with it. Otherwise, - there is no place to host the app's pages, and the service will throw an error. - - - - - - - Gets and sets the property ClientId. - - The client ID for the client app. - - - - - - Gets and sets the property CSS. - - The CSS values in the UI customization. - - - - - - Gets and sets the property ImageFile. - - The uploaded logo image for the UI customization. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the SetUICustomization operation. - - - - - Gets and sets the property UICustomization. - - The UI customization information. - - - - - - Container for the parameters to the SetUserMFAPreference operation. - Set the user's multi-factor authentication (MFA) method preference, including which - MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. If an MFA type is enabled for - a user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. If you would like MFA to be - applied selectively based on the assessed risk level of sign in attempts, disable - MFA for users and turn on Adaptive Authentication for the user pool. - - - - - Gets and sets the property AccessToken. - - The access token for the user. - - - - - - Gets and sets the property SMSMfaSettings. - - The SMS text message multi-factor authentication (MFA) settings. - - - - - - Gets and sets the property SoftwareTokenMfaSettings. - - The time-based one-time password software token MFA settings. - - - - - - This is the response object from the SetUserMFAPreference operation. - - - - - Container for the parameters to the SetUserPoolMfaConfig operation. - Set the user pool multi-factor authentication (MFA) configuration. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property MfaConfiguration. - - The MFA configuration. Users who don't have an MFA factor set up won't be able to - sign-in if you set the MfaConfiguration value to ‘ON’. See Adding - Multi-Factor Authentication (MFA) to a User Pool to learn more. Valid values include: - -
  • - - OFF MFA will not be used for any users. - -
  • - - ON MFA is required for all users to sign in. - -
  • - - OPTIONAL MFA will be required only for individual users who have an - MFA factor enabled. - -
- - - - - Gets and sets the property SmsMfaConfiguration. - - The SMS text message MFA configuration. - - - - - - Gets and sets the property SoftwareTokenMfaConfiguration. - - The software token MFA configuration. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the SetUserPoolMfaConfig operation. - - - - - Gets and sets the property MfaConfiguration. - - The MFA configuration. Valid values include: - -
  • - - OFF MFA will not be used for any users. - -
  • - - ON MFA is required for all users to sign in. - -
  • - - OPTIONAL MFA will be required only for individual users who have an - MFA factor enabled. - -
- - - - - Gets and sets the property SmsMfaConfiguration. - - The SMS text message MFA configuration. - - - - - - Gets and sets the property SoftwareTokenMfaConfiguration. - - The software token MFA configuration. - - - - - - Container for the parameters to the SetUserSettings operation. - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use SetUserMFAPreference - instead. - - - - - Gets and sets the property AccessToken. - - The access token for the set user settings request. - - - - - - Gets and sets the property MFAOptions. - - You can use this parameter only to set an SMS configuration that uses SMS for delivery. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response from the server for a set user settings request. - - - - - Container for the parameters to the SignUp operation. - Registers the user in the specified user pool and creates a user name, password, and - user attributes. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AnalyticsMetadata. - - The Amazon Pinpoint analytics metadata for collecting metrics for SignUp - calls. - - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the SignUp API action, Amazon Cognito invokes any functions that are - assigned to the following triggers: pre sign-up, custom message, and - post confirmation. When Amazon Cognito invokes any of these functions, it passes - a JSON payload, which the function receives as input. This payload contains a clientMetadata - attribute, which provides the data that you assigned to the ClientMetadata parameter - in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property Password. - - The password of the user you wish to register. - - - - - - Gets and sets the property SecretHash. - - A keyed-hash message authentication code (HMAC) calculated using the secret key of - a user pool client and username plus the client ID in the message. - - - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs representing user attributes. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Gets and sets the property UserContextData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to register. - - - - - - Gets and sets the property ValidationData. - - The validation data in the request to register a user. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - The response from the server for a registration request. - - - - - Gets and sets the property CodeDeliveryDetails. - - The code delivery details returned by the server response to the user registration - request. - - - - - - Gets and sets the property UserConfirmed. - - A response from the server indicating that a user registration has been confirmed. - - - - - - Gets and sets the property UserSub. - - The UUID of the authenticated user. This is not the same as username. - - - - - - The SMS configuration type that includes the settings the Cognito User Pool needs - to call for the Amazon SNS service to send an SMS message from your AWS account. The - Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM - role that you provide for your AWS account. - - - - - Gets and sets the property ExternalId. - - The external ID is a value that we recommend you use to add security to your IAM role - which is used to call Amazon SNS to send SMS messages for your user pool. If you provide - an ExternalId, the Cognito User Pool will include it when attempting - to assume your IAM role, so that you can set your roles trust policy to require the - ExternalID. If you use the Cognito Management Console to create a role - for SMS MFA, Cognito will create a role with the required permissions and a trust - policy that demonstrates use of the ExternalId. - - - - For more information about the ExternalId of a role, see How - to use an external ID when granting access to your AWS resources to a third party - - - - - - - Gets and sets the property SnsCallerArn. - - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. - This is the ARN of the IAM role in your AWS account which Cognito will use to send - SMS messages. SMS messages are subject to a spending - limit. - - - - - - The SMS text message multi-factor authentication (MFA) configuration type. - - - - - Gets and sets the property SmsAuthenticationMessage. - - The SMS authentication message that will be sent to users with the code they need - to sign in. The message must contain the ‘{####}’ placeholder, which will be replaced - with the code. If the message is not included, and default message will be used. - - - - - - Gets and sets the property SmsConfiguration. - - The SMS configuration. - - - - - - The type used for enabling SMS MFA at the user level. Phone numbers don't need to - be verified to be used for SMS MFA. If an MFA type is enabled for a user, the user - will be prompted for MFA during all sign in attempts, unless device tracking is turned - on and the device has been trusted. If you would like MFA to be applied selectively - based on the assessed risk level of sign in attempts, disable MFA for users and turn - on Adaptive Authentication for the user pool. - - - - - Gets and sets the property Enabled. - - Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a - user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. - - - - - - Gets and sets the property PreferredMfa. - - Specifies whether SMS is the preferred MFA method. - - - - - - The type used for enabling software token MFA at the user pool level. - - - - - Gets and sets the property Enabled. - - Specifies whether software token MFA is enabled. - - - - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - - - Constructs a new SoftwareTokenMFANotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of SoftwareTokenMFANotFoundException - - - - - - - Construct instance of SoftwareTokenMFANotFoundException - - - - - - Construct instance of SoftwareTokenMFANotFoundException - - - - - - - - - - - Construct instance of SoftwareTokenMFANotFoundException - - - - - - - - - - Constructs a new instance of the SoftwareTokenMFANotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The type used for enabling software token MFA at the user level. If an MFA type is - enabled for a user, the user will be prompted for MFA during all sign in attempts, - unless device tracking is turned on and the device has been trusted. If you would - like MFA to be applied selectively based on the assessed risk level of sign in attempts, - disable MFA for users and turn on Adaptive Authentication for the user pool. - - - - - Gets and sets the property Enabled. - - Specifies whether software token MFA is enabled. If an MFA type is enabled for a user, - the user will be prompted for MFA during all sign in attempts, unless device tracking - is turned on and the device has been trusted. - - - - - - Gets and sets the property PreferredMfa. - - Specifies whether software token MFA is the preferred MFA method. - - - - - - Container for the parameters to the StartUserImportJob operation. - Starts the user import. - - - - - Gets and sets the property JobId. - - The job ID for the user import job. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - Represents the response from the server to the request to start the user import job. - - - - - Gets and sets the property UserImportJob. - - The job object that represents the user import job. - - - - - - Container for the parameters to the StopUserImportJob operation. - Stops the user import job. - - - - - Gets and sets the property JobId. - - The job ID for the user import job. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - Represents the response from the server to the request to stop the user import job. - - - - - Gets and sets the property UserImportJob. - - The job object that represents the user import job. - - - - - - The constraints associated with a string attribute. - - - - - Gets and sets the property MaxLength. - - The maximum length. - - - - - - Gets and sets the property MinLength. - - The minimum length. - - - - - - Container for the parameters to the TagResource operation. - Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - Each tag consists of a key and value, both of which you define. A key is a general - category for more specific values. For example, if you have two versions of a user - pool, one for testing and another for production, you might assign an Environment - tag key to both user pools. The value of this key might be Test for one - user pool and Production for the other. - - - - Tags are useful for cost tracking and access control. You can activate your tags so - that they appear on the Billing and Cost Management console, where you can track the - costs associated with your user pools. In an IAM policy, you can constrain permissions - for user pools based on specific tags or tag values. - - - - You can use this action up to 5 times per second, per account. A user pool can have - as many as 50 tags. - - - - - - Gets and sets the property ResourceArn. - - The Amazon Resource Name (ARN) of the user pool to assign the tags to. - - - - - - Gets and sets the property Tags. - - The tags to assign to the user pool. - - - - - - This is the response object from the TagResource operation. - - - - - The data type for TokenValidityUnits that specifics the time measurements for token - validity. - - - - - Gets and sets the property AccessToken. - - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, - defaults to hours. - - - - - - Gets and sets the property IdToken. - - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, - defaults to hours. - - - - - - Gets and sets the property RefreshToken. - - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, - defaults to days. - - - - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - - - Constructs a new TooManyFailedAttemptsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TooManyFailedAttemptsException - - - - - - - Construct instance of TooManyFailedAttemptsException - - - - - - Construct instance of TooManyFailedAttemptsException - - - - - - - - - - - Construct instance of TooManyFailedAttemptsException - - - - - - - - - - Constructs a new instance of the TooManyFailedAttemptsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the user has made too many requests for a given operation. - - - - - Constructs a new TooManyRequestsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TooManyRequestsException - - - - - - - Construct instance of TooManyRequestsException - - - - - - Construct instance of TooManyRequestsException - - - - - - - - - - - Construct instance of TooManyRequestsException - - - - - - - - - - Constructs a new instance of the TooManyRequestsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A container for the UI customization information for a user pool's built-in app UI. - - - - - Gets and sets the property ClientId. - - The client ID for the client app. - - - - - - Gets and sets the property CreationDate. - - The creation date for the UI customization. - - - - - - Gets and sets the property CSS. - - The CSS values in the UI customization. - - - - - - Gets and sets the property CSSVersion. - - The CSS version number. - - - - - - Gets and sets the property ImageUrl. - - The logo image for the UI customization. - - - - - - Gets and sets the property LastModifiedDate. - - The last-modified date for the UI customization. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This exception is thrown when the request is not authorized. This can happen due to - an invalid access token in the request. - - - - - Constructs a new UnauthorizedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnauthorizedException - - - - - - - Construct instance of UnauthorizedException - - - - - - Construct instance of UnauthorizedException - - - - - - - - - - - Construct instance of UnauthorizedException - - - - - - - - - - Constructs a new instance of the UnauthorizedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - - - Constructs a new UnexpectedLambdaException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnexpectedLambdaException - - - - - - - Construct instance of UnexpectedLambdaException - - - - - - Construct instance of UnexpectedLambdaException - - - - - - - - - - - Construct instance of UnexpectedLambdaException - - - - - - - - - - Constructs a new instance of the UnexpectedLambdaException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when the specified identifier is not supported. - - - - - Constructs a new UnsupportedIdentityProviderException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnsupportedIdentityProviderException - - - - - - - Construct instance of UnsupportedIdentityProviderException - - - - - - Construct instance of UnsupportedIdentityProviderException - - - - - - - - - - - Construct instance of UnsupportedIdentityProviderException - - - - - - - - - - Constructs a new instance of the UnsupportedIdentityProviderException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when you attempt to perform an operation that is not enabled - for the user pool client. - - - - - Constructs a new UnsupportedOperationException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnsupportedOperationException - - - - - - - Construct instance of UnsupportedOperationException - - - - - - Construct instance of UnsupportedOperationException - - - - - - - - - - - Construct instance of UnsupportedOperationException - - - - - - - - - - Constructs a new instance of the UnsupportedOperationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when an unsupported token is passed to an operation. - - - - - Constructs a new UnsupportedTokenTypeException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnsupportedTokenTypeException - - - - - - - Construct instance of UnsupportedTokenTypeException - - - - - - Construct instance of UnsupportedTokenTypeException - - - - - - - - - - - Construct instance of UnsupportedTokenTypeException - - - - - - - - - - Constructs a new instance of the UnsupportedTokenTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The request failed because the user is in an unsupported state. - - - - - Constructs a new UnsupportedUserStateException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnsupportedUserStateException - - - - - - - Construct instance of UnsupportedUserStateException - - - - - - Construct instance of UnsupportedUserStateException - - - - - - - - - - - Construct instance of UnsupportedUserStateException - - - - - - - - - - Constructs a new instance of the UnsupportedUserStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the UntagResource operation. - Removes the specified tags from an Amazon Cognito user pool. You can use this action - up to 5 times per second, per account - - - - - Gets and sets the property ResourceArn. - - The Amazon Resource Name (ARN) of the user pool that the tags are assigned to. - - - - - - Gets and sets the property TagKeys. - - The keys of the tags to remove from the user pool. - - - - - - This is the response object from the UntagResource operation. - - - - - Container for the parameters to the UpdateAuthEventFeedback operation. - Provides the feedback for an authentication event whether it was from a valid user - or not. This feedback is used for improving the risk evaluation decision for the user - pool as part of Amazon Cognito advanced security. - - - - - Gets and sets the property EventId. - - The event ID. - - - - - - Gets and sets the property FeedbackToken. - - The feedback token. - - - - - - Gets and sets the property FeedbackValue. - - The authentication event feedback value. - - - - - - Gets and sets the property Username. - - The user pool username. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the UpdateAuthEventFeedback operation. - - - - - Container for the parameters to the UpdateDeviceStatus operation. - Updates the device status. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property DeviceKey. - - The device key. - - - - - - Gets and sets the property DeviceRememberedStatus. - - The status of whether a device is remembered. - - - - - - The response to the request to update the device status. - - - - - Container for the parameters to the UpdateGroup operation. - Updates the specified group with the specified attributes. - - - - Calling this action requires developer credentials. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - - - - Gets and sets the property Description. - - A string containing the new description of the group. - - - - - - Gets and sets the property GroupName. - - The name of the group. - - - - - - Gets and sets the property Precedence. - - The new precedence value for the group. For more information about this parameter, - see CreateGroup. - - - - - - Gets and sets the property RoleArn. - - The new role ARN for the group. This is used for setting the cognito:roles - and cognito:preferred_role claims in the token. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the UpdateGroup operation. - - - - - Gets and sets the property Group. - - The group object for the group. - - - - - - Container for the parameters to the UpdateIdentityProvider operation. - Updates identity provider information for a user pool. - - - - - Gets and sets the property AttributeMapping. - - The identity provider attribute mapping to be changed. - - - - - - Gets and sets the property IdpIdentifiers. - - A list of identity provider identifiers. - - - - - - Gets and sets the property ProviderDetails. - - The identity provider details to be updated, such as MetadataURL and - MetadataFile. - - - - - - Gets and sets the property ProviderName. - - The identity provider name. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID. - - - - - - This is the response object from the UpdateIdentityProvider operation. - - - - - Gets and sets the property IdentityProvider. - - The identity provider object. - - - - - - Container for the parameters to the UpdateResourceServer operation. - Updates the name and scopes of resource server. All other fields are read-only. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - - - - Gets and sets the property Identifier. - - The identifier for the resource server. - - - - - - Gets and sets the property Name. - - The name of the resource server. - - - - - - Gets and sets the property Scopes. - - The scope values to be set for the resource server. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool. - - - - - - This is the response object from the UpdateResourceServer operation. - - - - - Gets and sets the property ResourceServer. - - The resource server. - - - - - - Container for the parameters to the UpdateUserAttributes operation. - Allows a user to update a specific attribute (one at a time). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AccessToken. - - The access token for the request to update user attributes. - - - - - - Gets and sets the property ClientMetadata. - - A map of custom key-value pairs that you can provide as input for any custom workflows - that this action triggers. - - - - You create custom workflows by assigning AWS Lambda functions to user pool triggers. - When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function - that is assigned to the custom message trigger. When Amazon Cognito invokes - this function, it passes a JSON payload, which the function receives as input. This - payload contains a clientMetadata attribute, which provides the data - that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. - In your function code in AWS Lambda, you can process the clientMetadata - value to enhance your workflow for your specific needs. - - - - For more information, see Customizing - User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. - - - - Take the following limitations into consideration when you use the ClientMetadata - parameter: - -
  • - - Amazon Cognito does not store the ClientMetadata value. This data is available only - to AWS Lambda triggers that are assigned to a user pool to support custom workflows. - If your user pool configuration does not include triggers, the ClientMetadata parameter - serves no purpose. - -
  • - - Amazon Cognito does not validate the ClientMetadata value. - -
  • - - Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide - sensitive information. - -
- - - - - Gets and sets the property UserAttributes. - - An array of name-value pairs representing user attributes. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - Represents the response from the server for the request to update user attributes. - - - - - Gets and sets the property CodeDeliveryDetailsList. - - The code delivery details list from the server for the request to update user attributes. - - - - - - Container for the parameters to the UpdateUserPoolClient operation. - Updates the specified user pool app client with the specified attributes. You can - get a list of the current user pool app client settings using DescribeUserPoolClient. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - You can also use this operation to enable token revocation for user pool clients. - For more information about revoking tokens, see RevokeToken. - - - - - - Gets and sets the property AccessTokenValidity. - - The time limit, after which the access token is no longer valid and cannot be used. - - - - - - Gets and sets the property AllowedOAuthFlows. - - The allowed OAuth flows. - - - - Set to code to initiate a code grant flow, which provides an authorization - code as the response. This code can be exchanged for access tokens with the token - endpoint. - - - - Set to implicit to specify that the client should get the access token - (and, optionally, ID token, based on scopes) directly. - - - - Set to client_credentials to specify that the client should get the access - token (and, optionally, ID token, based on scopes) from the token endpoint using a - combination of client and client_secret. - - - - - - Gets and sets the property AllowedOAuthFlowsUserPoolClient. - - Set to true if the client is allowed to follow the OAuth protocol when interacting - with Cognito user pools. - - - - - - Gets and sets the property AllowedOAuthScopes. - - The allowed OAuth scopes. Possible values provided by OAuth are: phone, - email, openid, and profile. Possible values - provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created - in Resource Servers are also supported. - - - - - - Gets and sets the property AnalyticsConfiguration. - - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. - - - - In regions where Pinpoint is not available, Cognito User Pools only supports sending - events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, - Cognito User Pools will support sending events to Amazon Pinpoint projects within - that same region. - - - - - - - Gets and sets the property CallbackURLs. - - A list of allowed redirect (callback) URLs for the identity providers. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientName. - - The client name from the update user pool client request. - - - - - - Gets and sets the property DefaultRedirectURI. - - The default redirect URI. Must be in the CallbackURLs list. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property EnableTokenRevocation. - - Enables or disables token revocation. For more information about revoking tokens, - see RevokeToken. - - - - - - Gets and sets the property ExplicitAuthFlows. - - The authentication flows that are supported by the user pool clients. Flow names without - the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ - prefix. Note that values with ALLOW_ prefix cannot be used along with - values without ALLOW_ prefix. - - - - Valid values include: - -
  • - - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - setting. With this authentication flow, Cognito receives the password in the request - instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. - -
  • - - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. - -
  • - - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. - In this flow, Cognito receives the password in the request instead of using the SRP - protocol to verify passwords. - -
  • - - ALLOW_USER_SRP_AUTH: Enable SRP based authentication. - -
  • - - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - -
- - - - - Gets and sets the property IdTokenValidity. - - The time limit, after which the ID token is no longer valid and cannot be used. - - - - - - Gets and sets the property LogoutURLs. - - A list of allowed logout URLs for the identity providers. - - - - - - Gets and sets the property PreventUserExistenceErrors. - - Use this setting to choose which errors and responses are returned by Cognito APIs - during authentication, account confirmation, and password recovery when the user does - not exist in the user pool. When set to ENABLED and the user does not - exist, authentication returns an error indicating either the username or password - was incorrect, and account confirmation and password recovery return a response indicating - a code was sent to a simulated destination. When set to LEGACY, those - APIs will return a UserNotFoundException exception if the user does not - exist in the user pool. - - - - Valid values include: - -
  • - - ENABLED - This prevents user existence-related errors. - -
  • - - LEGACY - This represents the old behavior of Cognito where user existence - related errors are not prevented. - -
- - After February 15th 2020, the value of PreventUserExistenceErrors will - default to ENABLED for newly created user pool clients if no value is - provided. - - - - - - - Gets and sets the property ReadAttributes. - - The read-only attributes of the user pool. - - - - - - Gets and sets the property RefreshTokenValidity. - - The time limit, in days, after which the refresh token is no longer valid and cannot - be used. - - - - - - Gets and sets the property SupportedIdentityProviders. - - A list of provider names for the identity providers that are supported on this client. - - - - - - Gets and sets the property TokenValidityUnits. - - The units in which the validity times are represented in. Default for RefreshToken - is days, and default for ID and access tokens are hours. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to update the user pool client. - - - - - - Gets and sets the property WriteAttributes. - - The writeable attributes of the user pool. - - - - - - Represents the response from the server to the request to update the user pool client. - - - - - Gets and sets the property UserPoolClient. - - The user pool client value from the response from the server when an update user pool - client request is made. - - - - - - Container for the parameters to the UpdateUserPoolDomain operation. - Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your - user pool. - - - - You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate - to Amazon Cognito. You cannot use it to change the domain for a user pool. - - - - A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up - and sign-in pages for your application. When you set up a custom domain, you provide - a certificate that you manage with AWS Certificate Manager (ACM). When necessary, - you can use this operation to change the certificate that you applied to your custom - domain. - - - - Usually, this is unnecessary following routine certificate renewal with ACM. When - you renew your existing certificate in ACM, the ARN for your certificate remains the - same, and your custom domain uses the new certificate automatically. - - - - However, if you replace your existing certificate with a new one, ACM gives the new - certificate a new ARN. To apply the new certificate to your custom domain, you must - provide this ARN to Amazon Cognito. - - - - When you add your new certificate in ACM, you must choose US East (N. Virginia) as - the AWS Region. - - - - After you submit your request, Amazon Cognito requires up to 1 hour to distribute - your new certificate to your custom domain. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - - - - Gets and sets the property CustomDomainConfig. - - The configuration for a custom domain that hosts the sign-up and sign-in pages for - your application. Use this object to specify an SSL certificate that is managed by - ACM. - - - - - - Gets and sets the property Domain. - - The domain name for the custom domain that hosts the sign-up and sign-in pages for - your application. For example: auth.example.com. - - - - This string can include only lowercase letters, numbers, and hyphens. Do not use a - hyphen for the first or last character. Use periods to separate subdomain names. - - - - - - Gets and sets the property UserPoolId. - - The ID of the user pool that is associated with the custom domain that you are updating - the certificate for. - - - - - - The UpdateUserPoolDomain response output. - - - - - Gets and sets the property CloudFrontDomain. - - The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom - domain to your user pool. - - - - - - Container for the parameters to the UpdateUserPool operation. - Updates the specified user pool with the specified attributes. You can get a list - of the current user pool settings using DescribeUserPool. - If you don't provide a value for an attribute, it will be set to the default value. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - - - - Gets and sets the property AccountRecoverySetting. - - Use this setting to define which verified available method a user can use to recover - their password when they call ForgotPassword. It allows you to define - a preferred method when a user has more than one method available. With this setting, - SMS does not qualify for a valid password recovery mechanism if the user also has - SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior - to determine the recovery method where SMS is preferred over email. - - - - - - Gets and sets the property AdminCreateUserConfig. - - The configuration for AdminCreateUser requests. - - - - - - Gets and sets the property AutoVerifiedAttributes. - - The attributes that are automatically verified when the Amazon Cognito service makes - a request to update user pools. - - - - - - Gets and sets the property DeviceConfiguration. - - Device configuration. - - - - - - Gets and sets the property EmailConfiguration. - - Email configuration. - - - - - - Gets and sets the property EmailVerificationMessage. - - The contents of the email verification message. - - - - - - Gets and sets the property EmailVerificationSubject. - - The subject of the email verification message. - - - - - - Gets and sets the property LambdaConfig. - - The AWS Lambda configuration information from the request to update the user pool. - - - - - - Gets and sets the property MfaConfiguration. - - Can be one of the following values: - -
  • - - OFF - MFA tokens are not required and cannot be specified during user - registration. - -
  • - - ON - MFA tokens are required for all user registrations. You can only - specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig - API operation to turn MFA "ON" for existing user pools. - -
  • - - OPTIONAL - Users have the option when registering to create an MFA token. - -
- - - - - Gets and sets the property Policies. - - A container with the policies you wish to update in a user pool. - - - - - - Gets and sets the property SmsAuthenticationMessage. - - The contents of the SMS authentication message. - - - - - - Gets and sets the property SmsConfiguration. - - SMS configuration. - - - - - - Gets and sets the property SmsVerificationMessage. - - A container with information about the SMS verification message. - - - - - - Gets and sets the property UserPoolAddOns. - - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode - to the value "AUDIT". - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool you want to update. - - - - - - Gets and sets the property UserPoolTags. - - The tag keys and values to assign to the user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - - - Gets and sets the property VerificationMessageTemplate. - - The template for verification messages. - - - - - - Represents the response from the server when you make a request to update the user - pool. - - - - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - Gets and sets the property EncodedData. - - Contextual data such as the user's device fingerprint, IP address, or location used - for evaluating the risk of an unexpected event by Amazon Cognito advanced security. - - - - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - - - - Constructs a new UserImportInProgressException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserImportInProgressException - - - - - - - Construct instance of UserImportInProgressException - - - - - - Construct instance of UserImportInProgressException - - - - - - - - - - - Construct instance of UserImportInProgressException - - - - - - - - - - Constructs a new instance of the UserImportInProgressException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The user import job type. - - - - - Gets and sets the property CloudWatchLogsRoleArn. - - The role ARN for the Amazon CloudWatch Logging role for the user import job. For more - information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer - Guide. - - - - - - Gets and sets the property CompletionDate. - - The date when the user import job was completed. - - - - - - Gets and sets the property CompletionMessage. - - The message returned when the user import job is completed. - - - - - - Gets and sets the property CreationDate. - - The date the user import job was created. - - - - - - Gets and sets the property FailedUsers. - - The number of users that could not be imported. - - - - - - Gets and sets the property ImportedUsers. - - The number of users that were successfully imported. - - - - - - Gets and sets the property JobId. - - The job ID for the user import job. - - - - - - Gets and sets the property JobName. - - The job name for the user import job. - - - - - - Gets and sets the property PreSignedUrl. - - The pre-signed URL to be used to upload the .csv file. - - - - - - Gets and sets the property SkippedUsers. - - The number of users that were skipped. - - - - - - Gets and sets the property StartDate. - - The date when the user import job was started. - - - - - - Gets and sets the property Status. - - The status of the user import job. One of the following: - -
  • - - Created - The job was created but not started. - -
  • - - Pending - A transition state. You have started the job, but it has not - begun importing users yet. - -
  • - - InProgress - The job has started, and users are being imported. - -
  • - - Stopping - You have stopped the job, but the job has not stopped importing - users yet. - -
  • - - Stopped - You have stopped the job, and the job has stopped importing - users. - -
  • - - Succeeded - The job has completed successfully. - -
  • - - Failed - The job has stopped due to an error. - -
  • - - Expired - You created a job, but did not start the job within 24-48 - hours. All data associated with the job was deleted, and the job cannot be started. - -
- - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool that the users are being imported into. - - - - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - - - Constructs a new UserLambdaValidationException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserLambdaValidationException - - - - - - - Construct instance of UserLambdaValidationException - - - - - - Construct instance of UserLambdaValidationException - - - - - - - - - - - Construct instance of UserLambdaValidationException - - - - - - - - - - Constructs a new instance of the UserLambdaValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The username configuration type. - - - - - Gets and sets the property CaseSensitive. - - Specifies whether username case sensitivity will be applied for all users in the user - pool through Cognito APIs. - - - - Valid values include: - -
  • - - True : Enables case sensitivity for all username input. When - this option is set to True, users must sign in using the exact capitalization - of their given username. For example, “UserName”. This is the default value. - -
  • - - False : Enables case insensitivity for all username input. For - example, when this option is set to False, users will be able to sign - in using either "username" or "Username". This option also enables both preferred_username - and email alias to be case insensitive, in addition to the username - attribute. - -
- - - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - - - Constructs a new UsernameExistsException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UsernameExistsException - - - - - - - Construct instance of UsernameExistsException - - - - - - Construct instance of UsernameExistsException - - - - - - - - - - - Construct instance of UsernameExistsException - - - - - - - - - - Constructs a new instance of the UsernameExistsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when a user is not confirmed successfully. - - - - - Constructs a new UserNotConfirmedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserNotConfirmedException - - - - - - - Construct instance of UserNotConfirmedException - - - - - - Construct instance of UserNotConfirmedException - - - - - - - - - - - Construct instance of UserNotConfirmedException - - - - - - - - - - Constructs a new instance of the UserNotConfirmedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when a user is not found. - - - - - Constructs a new UserNotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserNotFoundException - - - - - - - Construct instance of UserNotFoundException - - - - - - Construct instance of UserNotFoundException - - - - - - - - - - - Construct instance of UserNotFoundException - - - - - - - - - - Constructs a new instance of the UserNotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when user pool add-ons are not enabled. - - - - - Constructs a new UserPoolAddOnNotEnabledException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserPoolAddOnNotEnabledException - - - - - - - Construct instance of UserPoolAddOnNotEnabledException - - - - - - Construct instance of UserPoolAddOnNotEnabledException - - - - - - - - - - - Construct instance of UserPoolAddOnNotEnabledException - - - - - - - - - - Constructs a new instance of the UserPoolAddOnNotEnabledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The user pool add-ons type. - - - - - Gets and sets the property AdvancedSecurityMode. - - The advanced security mode. - - - - - - The description of the user pool client. - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientName. - - The client name from the user pool client description. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool where you want to describe the user pool client. - - - - - - Contains information about a user pool client. - - - - - Gets and sets the property AccessTokenValidity. - - The time limit, specified by tokenValidityUnits, defaulting to hours, after which - the access token is no longer valid and cannot be used. - - - - - - Gets and sets the property AllowedOAuthFlows. - - The allowed OAuth flows. - - - - Set to code to initiate a code grant flow, which provides an authorization - code as the response. This code can be exchanged for access tokens with the token - endpoint. - - - - Set to implicit to specify that the client should get the access token - (and, optionally, ID token, based on scopes) directly. - - - - Set to client_credentials to specify that the client should get the access - token (and, optionally, ID token, based on scopes) from the token endpoint using a - combination of client and client_secret. - - - - - - Gets and sets the property AllowedOAuthFlowsUserPoolClient. - - Set to true if the client is allowed to follow the OAuth protocol when interacting - with Cognito user pools. - - - - - - Gets and sets the property AllowedOAuthScopes. - - The allowed OAuth scopes. Possible values provided by OAuth are: phone, - email, openid, and profile. Possible values - provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created - in Resource Servers are also supported. - - - - - - Gets and sets the property AnalyticsConfiguration. - - The Amazon Pinpoint analytics configuration for the user pool client. - - - - Cognito User Pools only supports sending events to Amazon Pinpoint projects in the - US East (N. Virginia) us-east-1 Region, regardless of the region in which the user - pool resides. - - - - - - - Gets and sets the property CallbackURLs. - - A list of allowed redirect (callback) URLs for the identity providers. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property ClientId. - - The ID of the client associated with the user pool. - - - - - - Gets and sets the property ClientName. - - The client name from the user pool request of the client type. - - - - - - Gets and sets the property ClientSecret. - - The client secret from the user pool request of the client type. - - - - - - Gets and sets the property CreationDate. - - The date the user pool client was created. - - - - - - Gets and sets the property DefaultRedirectURI. - - The default redirect URI. Must be in the CallbackURLs list. - - - - A redirect URI must: - -
  • - - Be an absolute URI. - -
  • - - Be registered with the authorization server. - -
  • - - Not include a fragment component. - -
- - See OAuth 2.0 - Redirection - Endpoint. - - - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - only. - - - - App callback URLs such as myapp://example are also supported. - - - - - - Gets and sets the property EnableTokenRevocation. - - Indicates whether token revocation is enabled for the user pool client. When you create - a new user pool client, token revocation is enabled by default. For more information - about revoking tokens, see RevokeToken. - - - - - - Gets and sets the property ExplicitAuthFlows. - - The authentication flows that are supported by the user pool clients. Flow names without - the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ - prefix. Note that values with ALLOW_ prefix cannot be used along with - values without ALLOW_ prefix. - - - - Valid values include: - -
  • - - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - setting. With this authentication flow, Cognito receives the password in the request - instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. - -
  • - - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. - -
  • - - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. - In this flow, Cognito receives the password in the request instead of using the SRP - protocol to verify passwords. - -
  • - - ALLOW_USER_SRP_AUTH: Enable SRP based authentication. - -
  • - - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - -
- - - - - Gets and sets the property IdTokenValidity. - - The time limit, specified by tokenValidityUnits, defaulting to hours, after which - the refresh token is no longer valid and cannot be used. - - - - - - Gets and sets the property LastModifiedDate. - - The date the user pool client was last modified. - - - - - - Gets and sets the property LogoutURLs. - - A list of allowed logout URLs for the identity providers. - - - - - - Gets and sets the property PreventUserExistenceErrors. - - Use this setting to choose which errors and responses are returned by Cognito APIs - during authentication, account confirmation, and password recovery when the user does - not exist in the user pool. When set to ENABLED and the user does not - exist, authentication returns an error indicating either the username or password - was incorrect, and account confirmation and password recovery return a response indicating - a code was sent to a simulated destination. When set to LEGACY, those - APIs will return a UserNotFoundException exception if the user does not - exist in the user pool. - - - - Valid values include: - -
  • - - ENABLED - This prevents user existence-related errors. - -
  • - - LEGACY - This represents the old behavior of Cognito where user existence - related errors are not prevented. - -
- - After February 15th 2020, the value of PreventUserExistenceErrors will - default to ENABLED for newly created user pool clients if no value is - provided. - - - - - - - Gets and sets the property ReadAttributes. - - The Read-only attributes. - - - - - - Gets and sets the property RefreshTokenValidity. - - The time limit, in days, after which the refresh token is no longer valid and cannot - be used. - - - - - - Gets and sets the property SupportedIdentityProviders. - - A list of provider names for the identity providers that are supported on this client. - - - - - - Gets and sets the property TokenValidityUnits. - - The time units used to specify the token validity times of their respective token. - - - - - - Gets and sets the property UserPoolId. - - The user pool ID for the user pool client. - - - - - - Gets and sets the property WriteAttributes. - - The writeable attributes. - - - - - - A user pool description. - - - - - Gets and sets the property CreationDate. - - The date the user pool description was created. - - - - - - Gets and sets the property Id. - - The ID in a user pool description. - - - - - - Gets and sets the property LambdaConfig. - - The AWS Lambda configuration information in a user pool description. - - - - - - Gets and sets the property LastModifiedDate. - - The date the user pool description was last modified. - - - - - - Gets and sets the property Name. - - The name in a user pool description. - - - - - - Gets and sets the property Status. - - The user pool status in a user pool description. - - - - - - The policy associated with a user pool. - - - - - Gets and sets the property PasswordPolicy. - - The password policy. - - - - - - This exception is thrown when a user pool tag cannot be set or updated. - - - - - Constructs a new UserPoolTaggingException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UserPoolTaggingException - - - - - - - Construct instance of UserPoolTaggingException - - - - - - Construct instance of UserPoolTaggingException - - - - - - - - - - - Construct instance of UserPoolTaggingException - - - - - - - - - - Constructs a new instance of the UserPoolTaggingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A container for information about the user pool. - - - - - Gets and sets the property AccountRecoverySetting. - - Use this setting to define which verified available method a user can use to recover - their password when they call ForgotPassword. It allows you to define - a preferred method when a user has more than one method available. With this setting, - SMS does not qualify for a valid password recovery mechanism if the user also has - SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior - to determine the recovery method where SMS is preferred over email. - - - - - - Gets and sets the property AdminCreateUserConfig. - - The configuration for AdminCreateUser requests. - - - - - - Gets and sets the property AliasAttributes. - - Specifies the attributes that are aliased in a user pool. - - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) for the user pool. - - - - - - Gets and sets the property AutoVerifiedAttributes. - - Specifies the attributes that are auto-verified in a user pool. - - - - - - Gets and sets the property CreationDate. - - The date the user pool was created. - - - - - - Gets and sets the property CustomDomain. - - A custom domain name that you provide to Amazon Cognito. This parameter applies only - if you use a custom domain to host the sign-up and sign-in pages for your application. - For example: auth.example.com. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - - - - Gets and sets the property DeviceConfiguration. - - The device configuration. - - - - - - Gets and sets the property Domain. - - Holds the domain prefix if the user pool has a domain associated with it. - - - - - - Gets and sets the property EmailConfiguration. - - The email configuration. - - - - - - Gets and sets the property EmailConfigurationFailure. - - The reason why the email configuration cannot send the messages to your users. - - - - - - Gets and sets the property EmailVerificationMessage. - - The contents of the email verification message. - - - - - - Gets and sets the property EmailVerificationSubject. - - The subject of the email verification message. - - - - - - Gets and sets the property EstimatedNumberOfUsers. - - A number estimating the size of the user pool. - - - - - - Gets and sets the property Id. - - The ID of the user pool. - - - - - - Gets and sets the property LambdaConfig. - - The AWS Lambda triggers associated with the user pool. - - - - - - Gets and sets the property LastModifiedDate. - - The date the user pool was last modified. - - - - - - Gets and sets the property MfaConfiguration. - - Can be one of the following values: - -
  • - - OFF - MFA tokens are not required and cannot be specified during user - registration. - -
  • - - ON - MFA tokens are required for all user registrations. You can only - specify required when you are initially creating a user pool. - -
  • - - OPTIONAL - Users have the option when registering to create an MFA token. - -
- - - - - Gets and sets the property Name. - - The name of the user pool. - - - - - - Gets and sets the property Policies. - - The policies associated with the user pool. - - - - - - Gets and sets the property SchemaAttributes. - - A container with the schema attributes of a user pool. - - - - - - Gets and sets the property SmsAuthenticationMessage. - - The contents of the SMS authentication message. - - - - - - Gets and sets the property SmsConfiguration. - - The SMS configuration. - - - - - - Gets and sets the property SmsConfigurationFailure. - - The reason why the SMS configuration cannot send the messages to your users. - - - - This message might include comma-separated values to describe why your SMS configuration - can't send messages to user pool end users. - -
  • - - InvalidSmsRoleAccessPolicyException - The IAM role which Cognito uses to send SMS - messages is not properly configured. For more information, see SmsConfigurationType. - -
  • - - SNSSandbox - The AWS account is in SNS Sandbox and messages won’t reach unverified - end users. This parameter won’t get populated with SNSSandbox if the IAM user creating - the user pool doesn’t have SNS permissions. To learn how to move your AWS account - out of the sandbox, see Moving - out of the SMS sandbox. - -
- - - - - Gets and sets the property SmsVerificationMessage. - - The contents of the SMS verification message. - - - - - - Gets and sets the property Status. - - The status of a user pool. - - - - - - Gets and sets the property UsernameAttributes. - - Specifies whether email addresses or phone numbers can be specified as usernames when - a user signs up. - - - - - - Gets and sets the property UsernameConfiguration. - - You can choose to enable case sensitivity on the username input for the selected sign-in - option. For example, when this is set to False, users will be able to - sign in using either "username" or "Username". This configuration is immutable once - it has been set. For more information, see UsernameConfigurationType. - - - - - - Gets and sets the property UserPoolAddOns. - - The user pool add-ons. - - - - - - Gets and sets the property UserPoolTags. - - The tags that are assigned to the user pool. A tag is a label that you can apply to - user pools to categorize and manage them in different ways, such as by purpose, owner, - environment, or other criteria. - - - - - - Gets and sets the property VerificationMessageTemplate. - - The template for verification messages. - - - - - - The user type. - - - - - Gets and sets the property Attributes. - - A container with information about the user type attributes. - - - - - - Gets and sets the property Enabled. - - Specifies whether the user is enabled. - - - - - - Gets and sets the property MFAOptions. - - The MFA options for the user. - - - - - - Gets and sets the property UserCreateDate. - - The creation date of the user. - - - - - - Gets and sets the property UserLastModifiedDate. - - The last modified date of the user. - - - - - - Gets and sets the property Username. - - The user name of the user you wish to describe. - - - - - - Gets and sets the property UserStatus. - - The user status. Can be one of the following: - -
  • - - UNCONFIRMED - User has been created but not confirmed. - -
  • - - CONFIRMED - User has been confirmed. - -
  • - - ARCHIVED - User is no longer active. - -
  • - - COMPROMISED - User is disabled due to a potential security threat. - -
  • - - UNKNOWN - User status is not known. - -
  • - - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his - or her password before he or she can sign in. - -
  • - - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary - password, but on first sign-in, the user must change his or her password to a new - value before doing anything else. - -
- - - - - The template for verification messages. - - - - - Gets and sets the property DefaultEmailOption. - - The default email option. - - - - - - Gets and sets the property EmailMessage. - - The email message template. EmailMessage is allowed only if - EmailSendingAccount is DEVELOPER. - - - - - - Gets and sets the property EmailMessageByLink. - - The email message template for sending a confirmation link to the user. EmailMessageByLink - is allowed only if - EmailSendingAccount is DEVELOPER. - - - - - - Gets and sets the property EmailSubject. - - The subject line for the email message template. EmailSubject is allowed only if EmailSendingAccount - is DEVELOPER. - - - - - - Gets and sets the property EmailSubjectByLink. - - The subject line for the email message template for sending a confirmation link to - the user. EmailSubjectByLink is allowed only - EmailSendingAccount is DEVELOPER. - - - - - - Gets and sets the property SmsMessage. - - The SMS message template. - - - - - - Container for the parameters to the VerifySoftwareToken operation. - Use this API to register a user's entered TOTP code and mark the user's software token - MFA status as "verified" if successful. The request takes an access token or a session - string, but not both. - - - - - Gets and sets the property AccessToken. - - The access token. - - - - - - Gets and sets the property FriendlyDeviceName. - - The friendly device name. - - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - - - - - - Gets and sets the property UserCode. - - The one time password computed using the secret code returned by AssociateSoftwareToken". - - - - - - This is the response object from the VerifySoftwareToken operation. - - - - - Gets and sets the property Session. - - The session which should be passed both ways in challenge-response calls to the service. - - - - - - Gets and sets the property Status. - - The status of the verify software token. - - - - - - Container for the parameters to the VerifyUserAttribute operation. - Verifies the specified user attributes in the user pool. - - - - - Gets and sets the property AccessToken. - - Represents the access token of the request to verify user attributes. - - - - - - Gets and sets the property AttributeName. - - The attribute name in the request to verify user attributes. - - - - - - Gets and sets the property Code. - - The verification code in the request to verify user attributes. - - - - - - Get the signer to use for this request. - - A signer for this request. - - - - A container representing the response from the server from the request to verify user - attributes. - - - - - Base class for AdminListGroupsForUser paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Groups - - - - - Base class for AdminListUserAuthEvents paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the AuthEvents - - - - - Paginators for the CognitoIdentityProvider service - - - - - Paginator for AdminListGroupsForUser operation - - - - - Paginator for AdminListUserAuthEvents operation - - - - - Paginator for ListGroups operation - - - - - Paginator for ListIdentityProviders operation - - - - - Paginator for ListResourceServers operation - - - - - Paginator for ListUserPoolClients operation - - - - - Paginator for ListUserPools operation - - - - - Paginator for ListUsers operation - - - - - Paginator for ListUsersInGroup operation - - - - - Paginator for the AdminListGroupsForUser operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Groups - - - - - Paginator for the AdminListUserAuthEvents operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the AuthEvents - - - - - Paginators for the CognitoIdentityProvider service - - - - - Paginator for AdminListGroupsForUser operation - - - - - Paginator for AdminListUserAuthEvents operation - - - - - Paginator for ListGroups operation - - - - - Paginator for ListIdentityProviders operation - - - - - Paginator for ListResourceServers operation - - - - - Paginator for ListUserPoolClients operation - - - - - Paginator for ListUserPools operation - - - - - Paginator for ListUsers operation - - - - - Paginator for ListUsersInGroup operation - - - - - Paginator for the ListGroups operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Groups - - - - - Paginator for the ListIdentityProviders operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Providers - - - - - Paginator for the ListResourceServers operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the ResourceServers - - - - - Paginator for the ListUserPoolClients operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the UserPoolClients - - - - - Paginator for the ListUserPools operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the UserPools - - - - - Paginator for the ListUsersInGroup operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Users - - - - - Paginator for the ListUsers operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Users - - - - - Base class for ListGroups paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Groups - - - - - Base class for ListIdentityProviders paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Providers - - - - - Base class for ListResourceServers paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the ResourceServers - - - - - Base class for ListUserPoolClients paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the UserPoolClients - - - - - Base class for ListUserPools paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the UserPools - - - - - Base class for ListUsersInGroup paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Users - - - - - Base class for ListUsers paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Users - - - - - Base class for CognitoIdentityProvider operation requests. - - - - - Constants used for properties of type AccountTakeoverEventActionType. - - - - - Constant BLOCK for AccountTakeoverEventActionType - - - - - Constant MFA_IF_CONFIGURED for AccountTakeoverEventActionType - - - - - Constant MFA_REQUIRED for AccountTakeoverEventActionType - - - - - Constant NO_ACTION for AccountTakeoverEventActionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type AdvancedSecurityModeType. - - - - - Constant AUDIT for AdvancedSecurityModeType - - - - - Constant ENFORCED for AdvancedSecurityModeType - - - - - Constant OFF for AdvancedSecurityModeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type AliasAttributeType. - - - - - Constant Email for AliasAttributeType - - - - - Constant Phone_number for AliasAttributeType - - - - - Constant Preferred_username for AliasAttributeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type AttributeDataType. - - - - - Constant Boolean for AttributeDataType - - - - - Constant DateTime for AttributeDataType - - - - - Constant Number for AttributeDataType - - - - - Constant String for AttributeDataType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type AuthFlowType. - - - - - Constant ADMIN_NO_SRP_AUTH for AuthFlowType - - - - - Constant ADMIN_USER_PASSWORD_AUTH for AuthFlowType - - - - - Constant CUSTOM_AUTH for AuthFlowType - - - - - Constant REFRESH_TOKEN for AuthFlowType - - - - - Constant REFRESH_TOKEN_AUTH for AuthFlowType - - - - - Constant USER_PASSWORD_AUTH for AuthFlowType - - - - - Constant USER_SRP_AUTH for AuthFlowType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChallengeName. - - - - - Constant Mfa for ChallengeName - - - - - Constant Password for ChallengeName - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChallengeNameType. - - - - - Constant ADMIN_NO_SRP_AUTH for ChallengeNameType - - - - - Constant CUSTOM_CHALLENGE for ChallengeNameType - - - - - Constant DEVICE_PASSWORD_VERIFIER for ChallengeNameType - - - - - Constant DEVICE_SRP_AUTH for ChallengeNameType - - - - - Constant MFA_SETUP for ChallengeNameType - - - - - Constant NEW_PASSWORD_REQUIRED for ChallengeNameType - - - - - Constant PASSWORD_VERIFIER for ChallengeNameType - - - - - Constant SELECT_MFA_TYPE for ChallengeNameType - - - - - Constant SMS_MFA for ChallengeNameType - - - - - Constant SOFTWARE_TOKEN_MFA for ChallengeNameType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ChallengeResponse. - - - - - Constant Failure for ChallengeResponse - - - - - Constant Success for ChallengeResponse - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type CompromisedCredentialsEventActionType. - - - - - Constant BLOCK for CompromisedCredentialsEventActionType - - - - - Constant NO_ACTION for CompromisedCredentialsEventActionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type CustomEmailSenderLambdaVersionType. - - - - - Constant V1_0 for CustomEmailSenderLambdaVersionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type CustomSMSSenderLambdaVersionType. - - - - - Constant V1_0 for CustomSMSSenderLambdaVersionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DefaultEmailOptionType. - - - - - Constant CONFIRM_WITH_CODE for DefaultEmailOptionType - - - - - Constant CONFIRM_WITH_LINK for DefaultEmailOptionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DeliveryMediumType. - - - - - Constant EMAIL for DeliveryMediumType - - - - - Constant SMS for DeliveryMediumType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DeviceRememberedStatusType. - - - - - Constant Not_remembered for DeviceRememberedStatusType - - - - - Constant Remembered for DeviceRememberedStatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type DomainStatusType. - - - - - Constant ACTIVE for DomainStatusType - - - - - Constant CREATING for DomainStatusType - - - - - Constant DELETING for DomainStatusType - - - - - Constant FAILED for DomainStatusType - - - - - Constant UPDATING for DomainStatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EmailSendingAccountType. - - - - - Constant COGNITO_DEFAULT for EmailSendingAccountType - - - - - Constant DEVELOPER for EmailSendingAccountType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EventFilterType. - - - - - Constant PASSWORD_CHANGE for EventFilterType - - - - - Constant SIGN_IN for EventFilterType - - - - - Constant SIGN_UP for EventFilterType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EventResponseType. - - - - - Constant Failure for EventResponseType - - - - - Constant Success for EventResponseType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EventType. - - - - - Constant ForgotPassword for EventType - - - - - Constant SignIn for EventType - - - - - Constant SignUp for EventType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ExplicitAuthFlowsType. - - - - - Constant ADMIN_NO_SRP_AUTH for ExplicitAuthFlowsType - - - - - Constant ALLOW_ADMIN_USER_PASSWORD_AUTH for ExplicitAuthFlowsType - - - - - Constant ALLOW_CUSTOM_AUTH for ExplicitAuthFlowsType - - - - - Constant ALLOW_REFRESH_TOKEN_AUTH for ExplicitAuthFlowsType - - - - - Constant ALLOW_USER_PASSWORD_AUTH for ExplicitAuthFlowsType - - - - - Constant ALLOW_USER_SRP_AUTH for ExplicitAuthFlowsType - - - - - Constant CUSTOM_AUTH_FLOW_ONLY for ExplicitAuthFlowsType - - - - - Constant USER_PASSWORD_AUTH for ExplicitAuthFlowsType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type FeedbackValueType. - - - - - Constant Invalid for FeedbackValueType - - - - - Constant Valid for FeedbackValueType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type IdentityProviderTypeType. - - - - - Constant Facebook for IdentityProviderTypeType - - - - - Constant Google for IdentityProviderTypeType - - - - - Constant LoginWithAmazon for IdentityProviderTypeType - - - - - Constant OIDC for IdentityProviderTypeType - - - - - Constant SAML for IdentityProviderTypeType - - - - - Constant SignInWithApple for IdentityProviderTypeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type MessageActionType. - - - - - Constant RESEND for MessageActionType - - - - - Constant SUPPRESS for MessageActionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type OAuthFlowType. - - - - - Constant Client_credentials for OAuthFlowType - - - - - Constant Code for OAuthFlowType - - - - - Constant Implicit for OAuthFlowType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PreventUserExistenceErrorTypes. - - - - - Constant ENABLED for PreventUserExistenceErrorTypes - - - - - Constant LEGACY for PreventUserExistenceErrorTypes - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RecoveryOptionNameType. - - - - - Constant Admin_only for RecoveryOptionNameType - - - - - Constant Verified_email for RecoveryOptionNameType - - - - - Constant Verified_phone_number for RecoveryOptionNameType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RiskDecisionType. - - - - - Constant AccountTakeover for RiskDecisionType - - - - - Constant Block for RiskDecisionType - - - - - Constant NoRisk for RiskDecisionType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RiskLevelType. - - - - - Constant High for RiskLevelType - - - - - Constant Low for RiskLevelType - - - - - Constant Medium for RiskLevelType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type StatusType. - - - - - Constant Disabled for StatusType - - - - - Constant Enabled for StatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type TimeUnitsType. - - - - - Constant Days for TimeUnitsType - - - - - Constant Hours for TimeUnitsType - - - - - Constant Minutes for TimeUnitsType - - - - - Constant Seconds for TimeUnitsType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type UserImportJobStatusType. - - - - - Constant Created for UserImportJobStatusType - - - - - Constant Expired for UserImportJobStatusType - - - - - Constant Failed for UserImportJobStatusType - - - - - Constant InProgress for UserImportJobStatusType - - - - - Constant Pending for UserImportJobStatusType - - - - - Constant Stopped for UserImportJobStatusType - - - - - Constant Stopping for UserImportJobStatusType - - - - - Constant Succeeded for UserImportJobStatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type UsernameAttributeType. - - - - - Constant Email for UsernameAttributeType - - - - - Constant Phone_number for UsernameAttributeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type UserPoolMfaType. - - - - - Constant OFF for UserPoolMfaType - - - - - Constant ON for UserPoolMfaType - - - - - Constant OPTIONAL for UserPoolMfaType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type UserStatusType. - - - - - Constant ARCHIVED for UserStatusType - - - - - Constant COMPROMISED for UserStatusType - - - - - Constant CONFIRMED for UserStatusType - - - - - Constant FORCE_CHANGE_PASSWORD for UserStatusType - - - - - Constant RESET_REQUIRED for UserStatusType - - - - - Constant UNCONFIRMED for UserStatusType - - - - - Constant UNKNOWN for UserStatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type VerifiedAttributeType. - - - - - Constant Email for VerifiedAttributeType - - - - - Constant Phone_number for VerifiedAttributeType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type VerifySoftwareTokenResponseType. - - - - - Constant ERROR for VerifySoftwareTokenResponseType - - - - - Constant SUCCESS for VerifySoftwareTokenResponseType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Implementation for accessing CognitoIdentityProvider - - Using the Amazon Cognito User Pools API, you can create a user pool to manage directories - and users. You can authenticate a user to obtain tokens related to user identity and - access policies. - - - - This API reference provides information about user pools in Amazon Cognito User Pools. - - - - For more information, see the Amazon - Cognito Documentation. - - - - - - Paginators for the service - - - - - Constructs AmazonCognitoIdentityProviderClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonCognitoIdentityProviderClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonCognitoIdentityProviderClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonCognitoIdentityProviderClient Configuration Object - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Credentials - - AWS Credentials - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Credentials and an - AmazonCognitoIdentityProviderClient Configuration object. - - AWS Credentials - The AmazonCognitoIdentityProviderClient Configuration Object - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID, AWS Secret Key and an - AmazonCognitoIdentityProviderClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonCognitoIdentityProviderClient Configuration Object - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonCognitoIdentityProviderClient with AWS Access Key ID, AWS Secret Key and an - AmazonCognitoIdentityProviderClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonCognitoIdentityProviderClient Configuration Object - - - - Creates the signer for the service. - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - Adds additional user attributes to the user pool schema. - - Container for the necessary parameters to execute the AddCustomAttributes service method. - - The response from the AddCustomAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for AddCustomAttributes Operation - - - - Adds additional user attributes to the user pool schema. - - Container for the necessary parameters to execute the AddCustomAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AddCustomAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for AddCustomAttributes Operation - - - - Adds the specified user to the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminAddUserToGroup service method. - - The response from the AdminAddUserToGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminAddUserToGroup Operation - - - - Adds the specified user to the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminAddUserToGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminAddUserToGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminAddUserToGroup Operation - - - - Confirms user registration as an admin without using a confirmation code. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminConfirmSignUp service method. - - The response from the AdminConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminConfirmSignUp Operation - - - - Confirms user registration as an admin without using a confirmation code. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminConfirmSignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminConfirmSignUp Operation - - - - Creates a new user in the specified user pool. - - - - If MessageAction is not set, the default is to send a welcome message - via email or phone (SMS). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - This message is based on a template that you configured in your call to create or - update a user pool. This template includes your custom sign-up instructions and placeholders - for user name and temporary password. - - - - Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction - parameter, and Amazon Cognito will not send any email. - - - - In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - they sign in and change their password. - - - - AdminCreateUser requires developer credentials. - - - Container for the necessary parameters to execute the AdminCreateUser service method. - - The response from the AdminCreateUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - The request failed because the user is in an unsupported state. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminCreateUser Operation - - - - Creates a new user in the specified user pool. - - - - If MessageAction is not set, the default is to send a welcome message - via email or phone (SMS). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - This message is based on a template that you configured in your call to create or - update a user pool. This template includes your custom sign-up instructions and placeholders - for user name and temporary password. - - - - Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction - parameter, and Amazon Cognito will not send any email. - - - - In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - they sign in and change their password. - - - - AdminCreateUser requires developer credentials. - - - Container for the necessary parameters to execute the AdminCreateUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminCreateUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - The request failed because the user is in an unsupported state. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminCreateUser Operation - - - - Deletes a user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUser service method. - - The response from the AdminDeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUser Operation - - - - Deletes a user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUser Operation - - - - Deletes the user attributes in a user pool as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUserAttributes service method. - - The response from the AdminDeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUserAttributes Operation - - - - Deletes the user attributes in a user pool as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUserAttributes Operation - - - - Disables the user from signing in with the specified external (SAML or social) identity - provider. If the user to disable is a Cognito User Pools native username + password - user, they are not permitted to use their password to sign-in. If the user to disable - is a linked external IdP user, any link between that user and an existing user is - removed. The next time the external user (no longer attached to the previously linked - DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. - - - - This action is enabled only for admin access and requires developer credentials. - - - - The ProviderName must match the value specified when creating an IdP - for the pool. - - - - To disable a native username + password user, the ProviderName value - must be Cognito and the ProviderAttributeName must be Cognito_Subject, - with the ProviderAttributeValue being the name that is used in the user - pool for the user. - - - - The ProviderAttributeName must always be Cognito_Subject - for social identity providers. The ProviderAttributeValue must always - be the exact subject that was used when the user was originally linked as a source - user. - - - - For de-linking a SAML identity, there are two scenarios. If the linked identity has - not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue - must be the same values that were used for the SourceUser when the identities - were originally linked using AdminLinkProviderForUser call. (If the - linking was done with ProviderAttributeName set to Cognito_Subject, - the same applies here). However, if the user has already signed in, the ProviderAttributeName - must be Cognito_Subject and ProviderAttributeValue must - be the subject of the SAML assertion. - - - Container for the necessary parameters to execute the AdminDisableProviderForUser service method. - - The response from the AdminDisableProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableProviderForUser Operation - - - - Disables the user from signing in with the specified external (SAML or social) identity - provider. If the user to disable is a Cognito User Pools native username + password - user, they are not permitted to use their password to sign-in. If the user to disable - is a linked external IdP user, any link between that user and an existing user is - removed. The next time the external user (no longer attached to the previously linked - DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. - - - - This action is enabled only for admin access and requires developer credentials. - - - - The ProviderName must match the value specified when creating an IdP - for the pool. - - - - To disable a native username + password user, the ProviderName value - must be Cognito and the ProviderAttributeName must be Cognito_Subject, - with the ProviderAttributeValue being the name that is used in the user - pool for the user. - - - - The ProviderAttributeName must always be Cognito_Subject - for social identity providers. The ProviderAttributeValue must always - be the exact subject that was used when the user was originally linked as a source - user. - - - - For de-linking a SAML identity, there are two scenarios. If the linked identity has - not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue - must be the same values that were used for the SourceUser when the identities - were originally linked using AdminLinkProviderForUser call. (If the - linking was done with ProviderAttributeName set to Cognito_Subject, - the same applies here). However, if the user has already signed in, the ProviderAttributeName - must be Cognito_Subject and ProviderAttributeValue must - be the subject of the SAML assertion. - - - Container for the necessary parameters to execute the AdminDisableProviderForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDisableProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableProviderForUser Operation - - - - Disables the specified user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDisableUser service method. - - The response from the AdminDisableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableUser Operation - - - - Disables the specified user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDisableUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDisableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableUser Operation - - - - Enables the specified user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminEnableUser service method. - - The response from the AdminEnableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminEnableUser Operation - - - - Enables the specified user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminEnableUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminEnableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminEnableUser Operation - - - - Forgets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminForgetDevice service method. - - The response from the AdminForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminForgetDevice Operation - - - - Forgets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminForgetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminForgetDevice Operation - - - - Gets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetDevice service method. - - The response from the AdminGetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminGetDevice Operation - - - - Gets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminGetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminGetDevice Operation - - - - Gets the specified user by user name in a user pool as an administrator. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetUser service method. - - The response from the AdminGetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminGetUser Operation - - - - Gets the specified user by user name in a user pool as an administrator. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminGetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminGetUser Operation - - - - Initiates the authentication flow, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminInitiateAuth service method. - - The response from the AdminInitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminInitiateAuth Operation - - - - Initiates the authentication flow, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminInitiateAuth service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminInitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminInitiateAuth Operation - - - - Links an existing user account in a user pool (DestinationUser) to an - identity from an external identity provider (SourceUser) based on a specified - attribute name and value from the external identity provider. This allows you to create - a link from the existing user account to an external federated user identity that - has not yet been used to sign in, so that the federated user identity can be used - to sign in as the existing user account. - - - - For example, if there is an existing user with a username and password, this API - links that user to a federated user identity, so that when the federated user identity - is used, the user signs in as the existing user account. - - - - The maximum number of federated identities linked to a user is 5. - - - - Because this API allows a user with an external federated identity to sign in as an - existing user in the user pool, it is critical that it only be used with external - identity providers and provider attributes that have been trusted by the application - owner. - - - - This action is enabled only for admin access and requires developer credentials. - - - Container for the necessary parameters to execute the AdminLinkProviderForUser service method. - - The response from the AdminLinkProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminLinkProviderForUser Operation - - - - Links an existing user account in a user pool (DestinationUser) to an - identity from an external identity provider (SourceUser) based on a specified - attribute name and value from the external identity provider. This allows you to create - a link from the existing user account to an external federated user identity that - has not yet been used to sign in, so that the federated user identity can be used - to sign in as the existing user account. - - - - For example, if there is an existing user with a username and password, this API - links that user to a federated user identity, so that when the federated user identity - is used, the user signs in as the existing user account. - - - - The maximum number of federated identities linked to a user is 5. - - - - Because this API allows a user with an external federated identity to sign in as an - existing user in the user pool, it is critical that it only be used with external - identity providers and provider attributes that have been trusted by the application - owner. - - - - This action is enabled only for admin access and requires developer credentials. - - - Container for the necessary parameters to execute the AdminLinkProviderForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminLinkProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminLinkProviderForUser Operation - - - - Lists devices, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListDevices service method. - - The response from the AdminListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminListDevices Operation - - - - Lists devices, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListDevices service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminListDevices Operation - - - - Lists the groups that the user belongs to. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListGroupsForUser service method. - - The response from the AdminListGroupsForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminListGroupsForUser Operation - - - - Lists the groups that the user belongs to. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListGroupsForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListGroupsForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminListGroupsForUser Operation - - - - Lists a history of user activity and any risks detected as part of Amazon Cognito - advanced security. - - Container for the necessary parameters to execute the AdminListUserAuthEvents service method. - - The response from the AdminListUserAuthEvents service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminListUserAuthEvents Operation - - - - Lists a history of user activity and any risks detected as part of Amazon Cognito - advanced security. - - Container for the necessary parameters to execute the AdminListUserAuthEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListUserAuthEvents service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminListUserAuthEvents Operation - - - - Removes the specified user from the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRemoveUserFromGroup service method. - - The response from the AdminRemoveUserFromGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRemoveUserFromGroup Operation - - - - Removes the specified user from the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRemoveUserFromGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminRemoveUserFromGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRemoveUserFromGroup Operation - - - - Resets the specified user's password in a user pool as an administrator. Works on - any user. - - - - When a developer calls this API, the current password is invalidated, so it must be - changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException - exception back and should direct the user down the flow to reset the password, which - is the same as the forgot password flow. In addition, if the user pool has phone verification - selected and a verified phone number exists for the user, or if email verification - is selected and a verified email exists for the user, calling this API will also result - in sending a message to the end user with the code to change their password. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminResetUserPassword service method. - - The response from the AdminResetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminResetUserPassword Operation - - - - Resets the specified user's password in a user pool as an administrator. Works on - any user. - - - - When a developer calls this API, the current password is invalidated, so it must be - changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException - exception back and should direct the user down the flow to reset the password, which - is the same as the forgot password flow. In addition, if the user pool has phone verification - selected and a verified phone number exists for the user, or if email verification - is selected and a verified email exists for the user, calling this API will also result - in sending a message to the end user with the code to change their password. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminResetUserPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminResetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminResetUserPassword Operation - - - - Responds to an authentication challenge, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRespondToAuthChallenge service method. - - The response from the AdminRespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRespondToAuthChallenge Operation - - - - Responds to an authentication challenge, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRespondToAuthChallenge service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminRespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRespondToAuthChallenge Operation - - - - Sets the user's multi-factor authentication (MFA) preference, including which MFA - options are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. - - Container for the necessary parameters to execute the AdminSetUserMFAPreference service method. - - The response from the AdminSetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserMFAPreference Operation - - - - Sets the user's multi-factor authentication (MFA) preference, including which MFA - options are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. - - Container for the necessary parameters to execute the AdminSetUserMFAPreference service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserMFAPreference Operation - - - - Sets the specified user's password in a user pool as an administrator. Works on any - user. - - - - The password can be temporary or permanent. If it is temporary, the user status will - be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries - to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED - challenge. If the user does not sign in before it expires, the user will not be able - to sign in and their password will need to be reset by an administrator. - - - - Once the user has set a new password, or the password is permanent, the user status - will be set to Confirmed. - - - Container for the necessary parameters to execute the AdminSetUserPassword service method. - - The response from the AdminSetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserPassword Operation - - - - Sets the specified user's password in a user pool as an administrator. Works on any - user. - - - - The password can be temporary or permanent. If it is temporary, the user status will - be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries - to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED - challenge. If the user does not sign in before it expires, the user will not be able - to sign in and their password will need to be reset by an administrator. - - - - Once the user has set a new password, or the password is permanent, the user status - will be set to Confirmed. - - - Container for the necessary parameters to execute the AdminSetUserPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserPassword Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use AdminSetUserMFAPreference - instead. - - Container for the necessary parameters to execute the AdminSetUserSettings service method. - - The response from the AdminSetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserSettings Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use AdminSetUserMFAPreference - instead. - - Container for the necessary parameters to execute the AdminSetUserSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserSettings Operation - - - - Provides feedback for an authentication event as to whether it was from a valid user. - This feedback is used for improving the risk evaluation decision for the user pool - as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the AdminUpdateAuthEventFeedback service method. - - The response from the AdminUpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminUpdateAuthEventFeedback Operation - - - - Provides feedback for an authentication event as to whether it was from a valid user. - This feedback is used for improving the risk evaluation decision for the user pool - as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the AdminUpdateAuthEventFeedback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminUpdateAuthEventFeedback Operation - - - - Updates the device status as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateDeviceStatus service method. - - The response from the AdminUpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateDeviceStatus Operation - - - - Updates the device status as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateDeviceStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateDeviceStatus Operation - - - - Updates the specified user's attributes, including developer attributes, as an administrator. - Works on any user. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - In addition to updating user attributes, this API can also be used to mark phone and - email as verified. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateUserAttributes service method. - - The response from the AdminUpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateUserAttributes Operation - - - - Updates the specified user's attributes, including developer attributes, as an administrator. - Works on any user. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - In addition to updating user attributes, this API can also be used to mark phone and - email as verified. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateUserAttributes Operation - - - - Signs out users from all devices, as an administrator. It also invalidates all refresh - tokens issued to a user. The user's current access and Id tokens remain valid until - their expiry. Access and Id tokens expire one hour after they are issued. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUserGlobalSignOut service method. - - The response from the AdminUserGlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUserGlobalSignOut Operation - - - - Signs out users from all devices, as an administrator. It also invalidates all refresh - tokens issued to a user. The user's current access and Id tokens remain valid until - their expiry. Access and Id tokens expire one hour after they are issued. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUserGlobalSignOut service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUserGlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUserGlobalSignOut Operation - - - - Returns a unique generated shared secret key code for the user account. The request - takes an access token or a session string, but not both. - - - - Calling AssociateSoftwareToken immediately disassociates the existing software token - from the user account. If the user doesn't subsequently verify the software token, - their account is essentially set up to authenticate without MFA. If MFA config is - set to Optional at the user pool level, the user can then login without MFA. However, - if MFA is set to Required for the user pool, the user will be asked to setup a new - software token MFA during sign in. - - - - Container for the necessary parameters to execute the AssociateSoftwareToken service method. - - The response from the AssociateSoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - REST API Reference for AssociateSoftwareToken Operation - - - - Returns a unique generated shared secret key code for the user account. The request - takes an access token or a session string, but not both. - - - - Calling AssociateSoftwareToken immediately disassociates the existing software token - from the user account. If the user doesn't subsequently verify the software token, - their account is essentially set up to authenticate without MFA. If MFA config is - set to Optional at the user pool level, the user can then login without MFA. However, - if MFA is set to Required for the user pool, the user will be asked to setup a new - software token MFA during sign in. - - - - Container for the necessary parameters to execute the AssociateSoftwareToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssociateSoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - REST API Reference for AssociateSoftwareToken Operation - - - - Changes the password for a specified user in a user pool. - - Container for the necessary parameters to execute the ChangePassword service method. - - The response from the ChangePassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ChangePassword Operation - - - - Changes the password for a specified user in a user pool. - - Container for the necessary parameters to execute the ChangePassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ChangePassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ChangePassword Operation - - - - Confirms tracking of the device. This API call is the call that begins device tracking. - - Container for the necessary parameters to execute the ConfirmDevice service method. - - The response from the ConfirmDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmDevice Operation - - - - Confirms tracking of the device. This API call is the call that begins device tracking. - - Container for the necessary parameters to execute the ConfirmDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmDevice Operation - - - - Allows a user to enter a confirmation code to reset a forgotten password. - - Container for the necessary parameters to execute the ConfirmForgotPassword service method. - - The response from the ConfirmForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmForgotPassword Operation - - - - Allows a user to enter a confirmation code to reset a forgotten password. - - Container for the necessary parameters to execute the ConfirmForgotPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmForgotPassword Operation - - - - Confirms registration of a user and handles the existing alias from a previous user. - - Container for the necessary parameters to execute the ConfirmSignUp service method. - - The response from the ConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmSignUp Operation - - - - Confirms registration of a user and handles the existing alias from a previous user. - - Container for the necessary parameters to execute the ConfirmSignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmSignUp Operation - - - - Creates a new group in the specified user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the CreateGroup service method. - - The response from the CreateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters a group that already exists - in the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateGroup Operation - - - - Creates a new group in the specified user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the CreateGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters a group that already exists - in the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateGroup Operation - - - - Creates an identity provider for a user pool. - - Container for the necessary parameters to execute the CreateIdentityProvider service method. - - The response from the CreateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when the provider is already supported by the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateIdentityProvider Operation - - - - Creates an identity provider for a user pool. - - Container for the necessary parameters to execute the CreateIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when the provider is already supported by the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateIdentityProvider Operation - - - - Creates a new OAuth2.0 resource server and defines custom scopes in it. - - Container for the necessary parameters to execute the CreateResourceServer service method. - - The response from the CreateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateResourceServer Operation - - - - Creates a new OAuth2.0 resource server and defines custom scopes in it. - - Container for the necessary parameters to execute the CreateResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateResourceServer Operation - - - - Creates the user import job. - - Container for the necessary parameters to execute the CreateUserImportJob service method. - - The response from the CreateUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserImportJob Operation - - - - Creates the user import job. - - Container for the necessary parameters to execute the CreateUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserImportJob Operation - - - - Creates a new Amazon Cognito user pool and sets the password policy for the pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the CreateUserPool service method. - - The response from the CreateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for CreateUserPool Operation - - - - Creates a new Amazon Cognito user pool and sets the password policy for the pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the CreateUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for CreateUserPool Operation - - - - Creates the user pool client. - - - - When you create a new user pool client, token revocation is automatically enabled. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the CreateUserPoolClient service method. - - The response from the CreateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserPoolClient Operation - - - - Creates the user pool client. - - - - When you create a new user pool client, token revocation is automatically enabled. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the CreateUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserPoolClient Operation - - - - Creates a new domain for a user pool. - - Container for the necessary parameters to execute the CreateUserPoolDomain service method. - - The response from the CreateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for CreateUserPoolDomain Operation - - - - Creates a new domain for a user pool. - - Container for the necessary parameters to execute the CreateUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for CreateUserPoolDomain Operation - - - - Deletes a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the DeleteGroup service method. - - The response from the DeleteGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteGroup Operation - - - - Deletes a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the DeleteGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteGroup Operation - - - - Deletes an identity provider for a user pool. - - Container for the necessary parameters to execute the DeleteIdentityProvider service method. - - The response from the DeleteIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for DeleteIdentityProvider Operation - - - - Deletes an identity provider for a user pool. - - Container for the necessary parameters to execute the DeleteIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for DeleteIdentityProvider Operation - - - - Deletes a resource server. - - Container for the necessary parameters to execute the DeleteResourceServer service method. - - The response from the DeleteResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteResourceServer Operation - - - - Deletes a resource server. - - Container for the necessary parameters to execute the DeleteResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteResourceServer Operation - - - - Allows a user to delete himself or herself. - - Container for the necessary parameters to execute the DeleteUser service method. - - The response from the DeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUser Operation - - - - Allows a user to delete himself or herself. - - Container for the necessary parameters to execute the DeleteUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUser Operation - - - - Deletes the attributes for a user. - - Container for the necessary parameters to execute the DeleteUserAttributes service method. - - The response from the DeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUserAttributes Operation - - - - Deletes the attributes for a user. - - Container for the necessary parameters to execute the DeleteUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUserAttributes Operation - - - - Deletes the specified Amazon Cognito user pool. - - Container for the necessary parameters to execute the DeleteUserPool service method. - - The response from the DeleteUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for DeleteUserPool Operation - - - - Deletes the specified Amazon Cognito user pool. - - Container for the necessary parameters to execute the DeleteUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for DeleteUserPool Operation - - - - Allows the developer to delete the user pool client. - - Container for the necessary parameters to execute the DeleteUserPoolClient service method. - - The response from the DeleteUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteUserPoolClient Operation - - - - Allows the developer to delete the user pool client. - - Container for the necessary parameters to execute the DeleteUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteUserPoolClient Operation - - - - Deletes a domain for a user pool. - - Container for the necessary parameters to execute the DeleteUserPoolDomain service method. - - The response from the DeleteUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DeleteUserPoolDomain Operation - - - - Deletes a domain for a user pool. - - Container for the necessary parameters to execute the DeleteUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DeleteUserPoolDomain Operation - - - - Gets information about a specific identity provider. - - Container for the necessary parameters to execute the DescribeIdentityProvider service method. - - The response from the DescribeIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeIdentityProvider Operation - - - - Gets information about a specific identity provider. - - Container for the necessary parameters to execute the DescribeIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeIdentityProvider Operation - - - - Describes a resource server. - - Container for the necessary parameters to execute the DescribeResourceServer service method. - - The response from the DescribeResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeResourceServer Operation - - - - Describes a resource server. - - Container for the necessary parameters to execute the DescribeResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeResourceServer Operation - - - - Describes the risk configuration. - - Container for the necessary parameters to execute the DescribeRiskConfiguration service method. - - The response from the DescribeRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for DescribeRiskConfiguration Operation - - - - Describes the risk configuration. - - Container for the necessary parameters to execute the DescribeRiskConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for DescribeRiskConfiguration Operation - - - - Describes the user import job. - - Container for the necessary parameters to execute the DescribeUserImportJob service method. - - The response from the DescribeUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserImportJob Operation - - - - Describes the user import job. - - Container for the necessary parameters to execute the DescribeUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserImportJob Operation - - - - Returns the configuration information and metadata of the specified user pool. - - Container for the necessary parameters to execute the DescribeUserPool service method. - - The response from the DescribeUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for DescribeUserPool Operation - - - - Returns the configuration information and metadata of the specified user pool. - - Container for the necessary parameters to execute the DescribeUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for DescribeUserPool Operation - - - - Client method for returning the configuration information and metadata of the specified - user pool app client. - - Container for the necessary parameters to execute the DescribeUserPoolClient service method. - - The response from the DescribeUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserPoolClient Operation - - - - Client method for returning the configuration information and metadata of the specified - user pool app client. - - Container for the necessary parameters to execute the DescribeUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserPoolClient Operation - - - - Gets information about a domain. - - Container for the necessary parameters to execute the DescribeUserPoolDomain service method. - - The response from the DescribeUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DescribeUserPoolDomain Operation - - - - Gets information about a domain. - - Container for the necessary parameters to execute the DescribeUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DescribeUserPoolDomain Operation - - - - Forgets the specified device. - - Container for the necessary parameters to execute the ForgetDevice service method. - - The response from the ForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgetDevice Operation - - - - Forgets the specified device. - - Container for the necessary parameters to execute the ForgetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgetDevice Operation - - - - Calling this API causes a message to be sent to the end user with a confirmation code - that is required to change the user's password. For the Username parameter, - you can use the username or user alias. The method used to send the confirmation code - is sent according to the specified AccountRecoverySetting. For more information, see - Recovering - User Accounts in the Amazon Cognito Developer Guide. If neither a verified - phone number nor a verified email exists, an InvalidParameterException - is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ForgotPassword service method. - - The response from the ForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgotPassword Operation - - - - Calling this API causes a message to be sent to the end user with a confirmation code - that is required to change the user's password. For the Username parameter, - you can use the username or user alias. The method used to send the confirmation code - is sent according to the specified AccountRecoverySetting. For more information, see - Recovering - User Accounts in the Amazon Cognito Developer Guide. If neither a verified - phone number nor a verified email exists, an InvalidParameterException - is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ForgotPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgotPassword Operation - - - - Gets the header information for the .csv file to be used as input for the user import - job. - - Container for the necessary parameters to execute the GetCSVHeader service method. - - The response from the GetCSVHeader service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetCSVHeader Operation - - - - Gets the header information for the .csv file to be used as input for the user import - job. - - Container for the necessary parameters to execute the GetCSVHeader service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCSVHeader service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetCSVHeader Operation - - - - Gets the device. - - Container for the necessary parameters to execute the GetDevice service method. - - The response from the GetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetDevice Operation - - - - Gets the device. - - Container for the necessary parameters to execute the GetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetDevice Operation - - - - Gets a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the GetGroup service method. - - The response from the GetGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetGroup Operation - - - - Gets a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the GetGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetGroup Operation - - - - Gets the specified identity provider. - - Container for the necessary parameters to execute the GetIdentityProviderByIdentifier service method. - - The response from the GetIdentityProviderByIdentifier service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetIdentityProviderByIdentifier Operation - - - - Gets the specified identity provider. - - Container for the necessary parameters to execute the GetIdentityProviderByIdentifier service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetIdentityProviderByIdentifier service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetIdentityProviderByIdentifier Operation - - - - This method takes a user pool ID, and returns the signing certificate. - - Container for the necessary parameters to execute the GetSigningCertificate service method. - - The response from the GetSigningCertificate service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for GetSigningCertificate Operation - - - - This method takes a user pool ID, and returns the signing certificate. - - Container for the necessary parameters to execute the GetSigningCertificate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSigningCertificate service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for GetSigningCertificate Operation - - - - Gets the UI Customization information for a particular app client's app UI, if there - is something set. If nothing is set for the particular client, but there is an existing - pool level customization (app clientId will be ALL), then - that is returned. If nothing is present, then an empty shape is returned. - - Container for the necessary parameters to execute the GetUICustomization service method. - - The response from the GetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUICustomization Operation - - - - Gets the UI Customization information for a particular app client's app UI, if there - is something set. If nothing is set for the particular client, but there is an existing - pool level customization (app clientId will be ALL), then - that is returned. If nothing is present, then an empty shape is returned. - - Container for the necessary parameters to execute the GetUICustomization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUICustomization Operation - - - - Gets the user attributes and metadata for a user. - - Container for the necessary parameters to execute the GetUser service method. - - The response from the GetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUser Operation - - - - Gets the user attributes and metadata for a user. - - Container for the necessary parameters to execute the GetUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUser Operation - - - - Gets the user attribute verification code for the specified attribute name. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the GetUserAttributeVerificationCode service method. - - The response from the GetUserAttributeVerificationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUserAttributeVerificationCode Operation - - - - Gets the user attribute verification code for the specified attribute name. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the GetUserAttributeVerificationCode service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUserAttributeVerificationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUserAttributeVerificationCode Operation - - - - Gets the user pool multi-factor authentication (MFA) configuration. - - Container for the necessary parameters to execute the GetUserPoolMfaConfig service method. - - The response from the GetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUserPoolMfaConfig Operation - - - - Gets the user pool multi-factor authentication (MFA) configuration. - - Container for the necessary parameters to execute the GetUserPoolMfaConfig service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUserPoolMfaConfig Operation - - - - Signs out users from all devices. It also invalidates all refresh tokens issued to - a user. The user's current access and Id tokens remain valid until their expiry. Access - and Id tokens expire one hour after they are issued. - - Container for the necessary parameters to execute the GlobalSignOut service method. - - The response from the GlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - REST API Reference for GlobalSignOut Operation - - - - Signs out users from all devices. It also invalidates all refresh tokens issued to - a user. The user's current access and Id tokens remain valid until their expiry. Access - and Id tokens expire one hour after they are issued. - - Container for the necessary parameters to execute the GlobalSignOut service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - REST API Reference for GlobalSignOut Operation - - - - Initiates the authentication flow. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the InitiateAuth service method. - - The response from the InitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for InitiateAuth Operation - - - - Initiates the authentication flow. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the InitiateAuth service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for InitiateAuth Operation - - - - Lists the devices. - - Container for the necessary parameters to execute the ListDevices service method. - - The response from the ListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ListDevices Operation - - - - Lists the devices. - - Container for the necessary parameters to execute the ListDevices service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ListDevices Operation - - - - Lists the groups associated with a user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListGroups service method. - - The response from the ListGroups service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListGroups Operation - - - - Lists the groups associated with a user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListGroups service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGroups service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListGroups Operation - - - - Lists information about all identity providers for a user pool. - - Container for the necessary parameters to execute the ListIdentityProviders service method. - - The response from the ListIdentityProviders service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListIdentityProviders Operation - - - - Lists information about all identity providers for a user pool. - - Container for the necessary parameters to execute the ListIdentityProviders service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListIdentityProviders service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListIdentityProviders Operation - - - - Lists the resource servers for a user pool. - - Container for the necessary parameters to execute the ListResourceServers service method. - - The response from the ListResourceServers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListResourceServers Operation - - - - Lists the resource servers for a user pool. - - Container for the necessary parameters to execute the ListResourceServers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListResourceServers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListResourceServers Operation - - - - Lists the tags that are assigned to an Amazon Cognito user pool. - - - - A tag is a label that you can apply to user pools to categorize and manage them in - different ways, such as by purpose, owner, environment, or other criteria. - - - - You can use this action up to 10 times per second, per account. - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - The response from the ListTagsForResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListTagsForResource Operation - - - - Lists the tags that are assigned to an Amazon Cognito user pool. - - - - A tag is a label that you can apply to user pools to categorize and manage them in - different ways, such as by purpose, owner, environment, or other criteria. - - - - You can use this action up to 10 times per second, per account. - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTagsForResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListTagsForResource Operation - - - - Lists the user import jobs. - - Container for the necessary parameters to execute the ListUserImportJobs service method. - - The response from the ListUserImportJobs service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserImportJobs Operation - - - - Lists the user import jobs. - - Container for the necessary parameters to execute the ListUserImportJobs service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserImportJobs service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserImportJobs Operation - - - - Lists the clients that have been created for the specified user pool. - - Container for the necessary parameters to execute the ListUserPoolClients service method. - - The response from the ListUserPoolClients service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPoolClients Operation - - - - Lists the clients that have been created for the specified user pool. - - Container for the necessary parameters to execute the ListUserPoolClients service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserPoolClients service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPoolClients Operation - - - - Lists the user pools associated with an AWS account. - - Container for the necessary parameters to execute the ListUserPools service method. - - The response from the ListUserPools service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPools Operation - - - - Lists the user pools associated with an AWS account. - - Container for the necessary parameters to execute the ListUserPools service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserPools service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPools Operation - - - - Lists the users in the Amazon Cognito user pool. - - Container for the necessary parameters to execute the ListUsers service method. - - The response from the ListUsers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsers Operation - - - - Lists the users in the Amazon Cognito user pool. - - Container for the necessary parameters to execute the ListUsers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUsers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsers Operation - - - - Lists the users in the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListUsersInGroup service method. - - The response from the ListUsersInGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsersInGroup Operation - - - - Lists the users in the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListUsersInGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUsersInGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsersInGroup Operation - - - - Resends the confirmation (for confirmation of registration) to a specific user in - the user pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ResendConfirmationCode service method. - - The response from the ResendConfirmationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ResendConfirmationCode Operation - - - - Resends the confirmation (for confirmation of registration) to a specific user in - the user pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ResendConfirmationCode service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResendConfirmationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ResendConfirmationCode Operation - - - - Responds to the authentication challenge. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the RespondToAuthChallenge service method. - - The response from the RespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for RespondToAuthChallenge Operation - - - - Responds to the authentication challenge. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the RespondToAuthChallenge service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for RespondToAuthChallenge Operation - - - - Revokes all of the access tokens generated by the specified refresh token. After the - token is revoked, you can not use the revoked token to access Cognito authenticated - APIs. - - Container for the necessary parameters to execute the RevokeToken service method. - - The response from the RevokeToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the request is not authorized. This can happen due to - an invalid access token in the request. - - - This exception is thrown when you attempt to perform an operation that is not enabled - for the user pool client. - - - This exception is thrown when an unsupported token is passed to an operation. - - REST API Reference for RevokeToken Operation - - - - Revokes all of the access tokens generated by the specified refresh token. After the - token is revoked, you can not use the revoked token to access Cognito authenticated - APIs. - - Container for the necessary parameters to execute the RevokeToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RevokeToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the request is not authorized. This can happen due to - an invalid access token in the request. - - - This exception is thrown when you attempt to perform an operation that is not enabled - for the user pool client. - - - This exception is thrown when an unsupported token is passed to an operation. - - REST API Reference for RevokeToken Operation - - - - Configures actions on detected risks. To delete the risk configuration for UserPoolId - or ClientId, pass null values for all four configuration types. - - - - To enable Amazon Cognito advanced security features, update the user pool to include - the UserPoolAddOns keyAdvancedSecurityMode. - - - Container for the necessary parameters to execute the SetRiskConfiguration service method. - - The response from the SetRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for SetRiskConfiguration Operation - - - - Configures actions on detected risks. To delete the risk configuration for UserPoolId - or ClientId, pass null values for all four configuration types. - - - - To enable Amazon Cognito advanced security features, update the user pool to include - the UserPoolAddOns keyAdvancedSecurityMode. - - - Container for the necessary parameters to execute the SetRiskConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for SetRiskConfiguration Operation - - - - Sets the UI customization information for a user pool's built-in app UI. - - - - You can specify app UI customization settings for a single client (with a specific - clientId) or for all clients (by setting the clientId to - ALL). If you specify ALL, the default configuration will - be used for every client that has no UI customization set previously. If you specify - UI customization settings for a particular client, it will no longer fall back to - the ALL configuration. - - - - To use this API, your user pool must have a domain associated with it. Otherwise, - there is no place to host the app's pages, and the service will throw an error. - - - - Container for the necessary parameters to execute the SetUICustomization service method. - - The response from the SetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUICustomization Operation - - - - Sets the UI customization information for a user pool's built-in app UI. - - - - You can specify app UI customization settings for a single client (with a specific - clientId) or for all clients (by setting the clientId to - ALL). If you specify ALL, the default configuration will - be used for every client that has no UI customization set previously. If you specify - UI customization settings for a particular client, it will no longer fall back to - the ALL configuration. - - - - To use this API, your user pool must have a domain associated with it. Otherwise, - there is no place to host the app's pages, and the service will throw an error. - - - - Container for the necessary parameters to execute the SetUICustomization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUICustomization Operation - - - - Set the user's multi-factor authentication (MFA) method preference, including which - MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. If an MFA type is enabled for - a user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. If you would like MFA to be - applied selectively based on the assessed risk level of sign in attempts, disable - MFA for users and turn on Adaptive Authentication for the user pool. - - Container for the necessary parameters to execute the SetUserMFAPreference service method. - - The response from the SetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserMFAPreference Operation - - - - Set the user's multi-factor authentication (MFA) method preference, including which - MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. If an MFA type is enabled for - a user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. If you would like MFA to be - applied selectively based on the assessed risk level of sign in attempts, disable - MFA for users and turn on Adaptive Authentication for the user pool. - - Container for the necessary parameters to execute the SetUserMFAPreference service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserMFAPreference Operation - - - - Set the user pool multi-factor authentication (MFA) configuration. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SetUserPoolMfaConfig service method. - - The response from the SetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUserPoolMfaConfig Operation - - - - Set the user pool multi-factor authentication (MFA) configuration. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SetUserPoolMfaConfig service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUserPoolMfaConfig Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use SetUserMFAPreference - instead. - - Container for the necessary parameters to execute the SetUserSettings service method. - - The response from the SetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserSettings Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use SetUserMFAPreference - instead. - - Container for the necessary parameters to execute the SetUserSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserSettings Operation - - - - Registers the user in the specified user pool and creates a user name, password, and - user attributes. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SignUp service method. - - The response from the SignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - REST API Reference for SignUp Operation - - - - Registers the user in the specified user pool and creates a user name, password, and - user attributes. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - REST API Reference for SignUp Operation - - - - Starts the user import. - - Container for the necessary parameters to execute the StartUserImportJob service method. - - The response from the StartUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StartUserImportJob Operation - - - - Starts the user import. - - Container for the necessary parameters to execute the StartUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StartUserImportJob Operation - - - - Stops the user import job. - - Container for the necessary parameters to execute the StopUserImportJob service method. - - The response from the StopUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StopUserImportJob Operation - - - - Stops the user import job. - - Container for the necessary parameters to execute the StopUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StopUserImportJob Operation - - - - Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - Each tag consists of a key and value, both of which you define. A key is a general - category for more specific values. For example, if you have two versions of a user - pool, one for testing and another for production, you might assign an Environment - tag key to both user pools. The value of this key might be Test for one - user pool and Production for the other. - - - - Tags are useful for cost tracking and access control. You can activate your tags so - that they appear on the Billing and Cost Management console, where you can track the - costs associated with your user pools. In an IAM policy, you can constrain permissions - for user pools based on specific tags or tag values. - - - - You can use this action up to 5 times per second, per account. A user pool can have - as many as 50 tags. - - - Container for the necessary parameters to execute the TagResource service method. - - The response from the TagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for TagResource Operation - - - - Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - Each tag consists of a key and value, both of which you define. A key is a general - category for more specific values. For example, if you have two versions of a user - pool, one for testing and another for production, you might assign an Environment - tag key to both user pools. The value of this key might be Test for one - user pool and Production for the other. - - - - Tags are useful for cost tracking and access control. You can activate your tags so - that they appear on the Billing and Cost Management console, where you can track the - costs associated with your user pools. In an IAM policy, you can constrain permissions - for user pools based on specific tags or tag values. - - - - You can use this action up to 5 times per second, per account. A user pool can have - as many as 50 tags. - - - Container for the necessary parameters to execute the TagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for TagResource Operation - - - - Removes the specified tags from an Amazon Cognito user pool. You can use this action - up to 5 times per second, per account - - Container for the necessary parameters to execute the UntagResource service method. - - The response from the UntagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UntagResource Operation - - - - Removes the specified tags from an Amazon Cognito user pool. You can use this action - up to 5 times per second, per account - - Container for the necessary parameters to execute the UntagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UntagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UntagResource Operation - - - - Provides the feedback for an authentication event whether it was from a valid user - or not. This feedback is used for improving the risk evaluation decision for the user - pool as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the UpdateAuthEventFeedback service method. - - The response from the UpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for UpdateAuthEventFeedback Operation - - - - Provides the feedback for an authentication event whether it was from a valid user - or not. This feedback is used for improving the risk evaluation decision for the user - pool as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the UpdateAuthEventFeedback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for UpdateAuthEventFeedback Operation - - - - Updates the device status. - - Container for the necessary parameters to execute the UpdateDeviceStatus service method. - - The response from the UpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateDeviceStatus Operation - - - - Updates the device status. - - Container for the necessary parameters to execute the UpdateDeviceStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateDeviceStatus Operation - - - - Updates the specified group with the specified attributes. - - - - Calling this action requires developer credentials. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateGroup service method. - - The response from the UpdateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateGroup Operation - - - - Updates the specified group with the specified attributes. - - - - Calling this action requires developer credentials. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateGroup Operation - - - - Updates identity provider information for a user pool. - - Container for the necessary parameters to execute the UpdateIdentityProvider service method. - - The response from the UpdateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for UpdateIdentityProvider Operation - - - - Updates identity provider information for a user pool. - - Container for the necessary parameters to execute the UpdateIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for UpdateIdentityProvider Operation - - - - Updates the name and scopes of resource server. All other fields are read-only. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateResourceServer service method. - - The response from the UpdateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateResourceServer Operation - - - - Updates the name and scopes of resource server. All other fields are read-only. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateResourceServer Operation - - - - Allows a user to update a specific attribute (one at a time). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserAttributes service method. - - The response from the UpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateUserAttributes Operation - - - - Allows a user to update a specific attribute (one at a time). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateUserAttributes Operation - - - - Updates the specified user pool with the specified attributes. You can get a list - of the current user pool settings using DescribeUserPool. - If you don't provide a value for an attribute, it will be set to the default value. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserPool service method. - - The response from the UpdateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for UpdateUserPool Operation - - - - Updates the specified user pool with the specified attributes. You can get a list - of the current user pool settings using DescribeUserPool. - If you don't provide a value for an attribute, it will be set to the default value. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for UpdateUserPool Operation - - - - Updates the specified user pool app client with the specified attributes. You can - get a list of the current user pool app client settings using DescribeUserPoolClient. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - You can also use this operation to enable token revocation for user pool clients. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the UpdateUserPoolClient service method. - - The response from the UpdateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolClient Operation - - - - Updates the specified user pool app client with the specified attributes. You can - get a list of the current user pool app client settings using DescribeUserPoolClient. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - You can also use this operation to enable token revocation for user pool clients. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the UpdateUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolClient Operation - - - - Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your - user pool. - - - - You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate - to Amazon Cognito. You cannot use it to change the domain for a user pool. - - - - A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up - and sign-in pages for your application. When you set up a custom domain, you provide - a certificate that you manage with AWS Certificate Manager (ACM). When necessary, - you can use this operation to change the certificate that you applied to your custom - domain. - - - - Usually, this is unnecessary following routine certificate renewal with ACM. When - you renew your existing certificate in ACM, the ARN for your certificate remains the - same, and your custom domain uses the new certificate automatically. - - - - However, if you replace your existing certificate with a new one, ACM gives the new - certificate a new ARN. To apply the new certificate to your custom domain, you must - provide this ARN to Amazon Cognito. - - - - When you add your new certificate in ACM, you must choose US East (N. Virginia) as - the AWS Region. - - - - After you submit your request, Amazon Cognito requires up to 1 hour to distribute - your new certificate to your custom domain. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - Container for the necessary parameters to execute the UpdateUserPoolDomain service method. - - The response from the UpdateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolDomain Operation - - - - Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your - user pool. - - - - You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate - to Amazon Cognito. You cannot use it to change the domain for a user pool. - - - - A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up - and sign-in pages for your application. When you set up a custom domain, you provide - a certificate that you manage with AWS Certificate Manager (ACM). When necessary, - you can use this operation to change the certificate that you applied to your custom - domain. - - - - Usually, this is unnecessary following routine certificate renewal with ACM. When - you renew your existing certificate in ACM, the ARN for your certificate remains the - same, and your custom domain uses the new certificate automatically. - - - - However, if you replace your existing certificate with a new one, ACM gives the new - certificate a new ARN. To apply the new certificate to your custom domain, you must - provide this ARN to Amazon Cognito. - - - - When you add your new certificate in ACM, you must choose US East (N. Virginia) as - the AWS Region. - - - - After you submit your request, Amazon Cognito requires up to 1 hour to distribute - your new certificate to your custom domain. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - Container for the necessary parameters to execute the UpdateUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolDomain Operation - - - - Use this API to register a user's entered TOTP code and mark the user's software token - MFA status as "verified" if successful. The request takes an access token or a session - string, but not both. - - Container for the necessary parameters to execute the VerifySoftwareToken service method. - - The response from the VerifySoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown when there is a code mismatch and the service fails to configure - the software token TOTP multi-factor authentication (MFA). - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifySoftwareToken Operation - - - - Use this API to register a user's entered TOTP code and mark the user's software token - MFA status as "verified" if successful. The request takes an access token or a session - string, but not both. - - Container for the necessary parameters to execute the VerifySoftwareToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the VerifySoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown when there is a code mismatch and the service fails to configure - the software token TOTP multi-factor authentication (MFA). - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifySoftwareToken Operation - - - - Verifies the specified user attributes in the user pool. - - Container for the necessary parameters to execute the VerifyUserAttribute service method. - - The response from the VerifyUserAttribute service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifyUserAttribute Operation - - - - Verifies the specified user attributes in the user pool. - - Container for the necessary parameters to execute the VerifyUserAttribute service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the VerifyUserAttribute service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifyUserAttribute Operation - - - - Interface for accessing CognitoIdentityProvider - - Using the Amazon Cognito User Pools API, you can create a user pool to manage directories - and users. You can authenticate a user to obtain tokens related to user identity and - access policies. - - - - This API reference provides information about user pools in Amazon Cognito User Pools. - - - - For more information, see the Amazon - Cognito Documentation. - - - - - - Paginators for the service - - - - - Adds additional user attributes to the user pool schema. - - Container for the necessary parameters to execute the AddCustomAttributes service method. - - The response from the AddCustomAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for AddCustomAttributes Operation - - - - Adds additional user attributes to the user pool schema. - - Container for the necessary parameters to execute the AddCustomAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AddCustomAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for AddCustomAttributes Operation - - - - Adds the specified user to the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminAddUserToGroup service method. - - The response from the AdminAddUserToGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminAddUserToGroup Operation - - - - Adds the specified user to the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminAddUserToGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminAddUserToGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminAddUserToGroup Operation - - - - Confirms user registration as an admin without using a confirmation code. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminConfirmSignUp service method. - - The response from the AdminConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminConfirmSignUp Operation - - - - Confirms user registration as an admin without using a confirmation code. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminConfirmSignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminConfirmSignUp Operation - - - - Creates a new user in the specified user pool. - - - - If MessageAction is not set, the default is to send a welcome message - via email or phone (SMS). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - This message is based on a template that you configured in your call to create or - update a user pool. This template includes your custom sign-up instructions and placeholders - for user name and temporary password. - - - - Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction - parameter, and Amazon Cognito will not send any email. - - - - In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - they sign in and change their password. - - - - AdminCreateUser requires developer credentials. - - - Container for the necessary parameters to execute the AdminCreateUser service method. - - The response from the AdminCreateUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - The request failed because the user is in an unsupported state. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminCreateUser Operation - - - - Creates a new user in the specified user pool. - - - - If MessageAction is not set, the default is to send a welcome message - via email or phone (SMS). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - This message is based on a template that you configured in your call to create or - update a user pool. This template includes your custom sign-up instructions and placeholders - for user name and temporary password. - - - - Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction - parameter, and Amazon Cognito will not send any email. - - - - In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - they sign in and change their password. - - - - AdminCreateUser requires developer credentials. - - - Container for the necessary parameters to execute the AdminCreateUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminCreateUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - The request failed because the user is in an unsupported state. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminCreateUser Operation - - - - Deletes a user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUser service method. - - The response from the AdminDeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUser Operation - - - - Deletes a user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUser Operation - - - - Deletes the user attributes in a user pool as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUserAttributes service method. - - The response from the AdminDeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUserAttributes Operation - - - - Deletes the user attributes in a user pool as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDeleteUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDeleteUserAttributes Operation - - - - Disables the user from signing in with the specified external (SAML or social) identity - provider. If the user to disable is a Cognito User Pools native username + password - user, they are not permitted to use their password to sign-in. If the user to disable - is a linked external IdP user, any link between that user and an existing user is - removed. The next time the external user (no longer attached to the previously linked - DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. - - - - This action is enabled only for admin access and requires developer credentials. - - - - The ProviderName must match the value specified when creating an IdP - for the pool. - - - - To disable a native username + password user, the ProviderName value - must be Cognito and the ProviderAttributeName must be Cognito_Subject, - with the ProviderAttributeValue being the name that is used in the user - pool for the user. - - - - The ProviderAttributeName must always be Cognito_Subject - for social identity providers. The ProviderAttributeValue must always - be the exact subject that was used when the user was originally linked as a source - user. - - - - For de-linking a SAML identity, there are two scenarios. If the linked identity has - not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue - must be the same values that were used for the SourceUser when the identities - were originally linked using AdminLinkProviderForUser call. (If the - linking was done with ProviderAttributeName set to Cognito_Subject, - the same applies here). However, if the user has already signed in, the ProviderAttributeName - must be Cognito_Subject and ProviderAttributeValue must - be the subject of the SAML assertion. - - - Container for the necessary parameters to execute the AdminDisableProviderForUser service method. - - The response from the AdminDisableProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableProviderForUser Operation - - - - Disables the user from signing in with the specified external (SAML or social) identity - provider. If the user to disable is a Cognito User Pools native username + password - user, they are not permitted to use their password to sign-in. If the user to disable - is a linked external IdP user, any link between that user and an existing user is - removed. The next time the external user (no longer attached to the previously linked - DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. - - - - This action is enabled only for admin access and requires developer credentials. - - - - The ProviderName must match the value specified when creating an IdP - for the pool. - - - - To disable a native username + password user, the ProviderName value - must be Cognito and the ProviderAttributeName must be Cognito_Subject, - with the ProviderAttributeValue being the name that is used in the user - pool for the user. - - - - The ProviderAttributeName must always be Cognito_Subject - for social identity providers. The ProviderAttributeValue must always - be the exact subject that was used when the user was originally linked as a source - user. - - - - For de-linking a SAML identity, there are two scenarios. If the linked identity has - not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue - must be the same values that were used for the SourceUser when the identities - were originally linked using AdminLinkProviderForUser call. (If the - linking was done with ProviderAttributeName set to Cognito_Subject, - the same applies here). However, if the user has already signed in, the ProviderAttributeName - must be Cognito_Subject and ProviderAttributeValue must - be the subject of the SAML assertion. - - - Container for the necessary parameters to execute the AdminDisableProviderForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDisableProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableProviderForUser Operation - - - - Disables the specified user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDisableUser service method. - - The response from the AdminDisableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableUser Operation - - - - Disables the specified user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminDisableUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminDisableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminDisableUser Operation - - - - Enables the specified user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminEnableUser service method. - - The response from the AdminEnableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminEnableUser Operation - - - - Enables the specified user as an administrator. Works on any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminEnableUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminEnableUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminEnableUser Operation - - - - Forgets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminForgetDevice service method. - - The response from the AdminForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminForgetDevice Operation - - - - Forgets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminForgetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminForgetDevice Operation - - - - Gets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetDevice service method. - - The response from the AdminGetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminGetDevice Operation - - - - Gets the device, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminGetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminGetDevice Operation - - - - Gets the specified user by user name in a user pool as an administrator. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetUser service method. - - The response from the AdminGetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminGetUser Operation - - - - Gets the specified user by user name in a user pool as an administrator. Works on - any user. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminGetUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminGetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminGetUser Operation - - - - Initiates the authentication flow, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminInitiateAuth service method. - - The response from the AdminInitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminInitiateAuth Operation - - - - Initiates the authentication flow, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminInitiateAuth service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminInitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminInitiateAuth Operation - - - - Links an existing user account in a user pool (DestinationUser) to an - identity from an external identity provider (SourceUser) based on a specified - attribute name and value from the external identity provider. This allows you to create - a link from the existing user account to an external federated user identity that - has not yet been used to sign in, so that the federated user identity can be used - to sign in as the existing user account. - - - - For example, if there is an existing user with a username and password, this API - links that user to a federated user identity, so that when the federated user identity - is used, the user signs in as the existing user account. - - - - The maximum number of federated identities linked to a user is 5. - - - - Because this API allows a user with an external federated identity to sign in as an - existing user in the user pool, it is critical that it only be used with external - identity providers and provider attributes that have been trusted by the application - owner. - - - - This action is enabled only for admin access and requires developer credentials. - - - Container for the necessary parameters to execute the AdminLinkProviderForUser service method. - - The response from the AdminLinkProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminLinkProviderForUser Operation - - - - Links an existing user account in a user pool (DestinationUser) to an - identity from an external identity provider (SourceUser) based on a specified - attribute name and value from the external identity provider. This allows you to create - a link from the existing user account to an external federated user identity that - has not yet been used to sign in, so that the federated user identity can be used - to sign in as the existing user account. - - - - For example, if there is an existing user with a username and password, this API - links that user to a federated user identity, so that when the federated user identity - is used, the user signs in as the existing user account. - - - - The maximum number of federated identities linked to a user is 5. - - - - Because this API allows a user with an external federated identity to sign in as an - existing user in the user pool, it is critical that it only be used with external - identity providers and provider attributes that have been trusted by the application - owner. - - - - This action is enabled only for admin access and requires developer credentials. - - - Container for the necessary parameters to execute the AdminLinkProviderForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminLinkProviderForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminLinkProviderForUser Operation - - - - Lists devices, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListDevices service method. - - The response from the AdminListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminListDevices Operation - - - - Lists devices, as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListDevices service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for AdminListDevices Operation - - - - Lists the groups that the user belongs to. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListGroupsForUser service method. - - The response from the AdminListGroupsForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminListGroupsForUser Operation - - - - Lists the groups that the user belongs to. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminListGroupsForUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListGroupsForUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminListGroupsForUser Operation - - - - Lists a history of user activity and any risks detected as part of Amazon Cognito - advanced security. - - Container for the necessary parameters to execute the AdminListUserAuthEvents service method. - - The response from the AdminListUserAuthEvents service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminListUserAuthEvents Operation - - - - Lists a history of user activity and any risks detected as part of Amazon Cognito - advanced security. - - Container for the necessary parameters to execute the AdminListUserAuthEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminListUserAuthEvents service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminListUserAuthEvents Operation - - - - Removes the specified user from the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRemoveUserFromGroup service method. - - The response from the AdminRemoveUserFromGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRemoveUserFromGroup Operation - - - - Removes the specified user from the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRemoveUserFromGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminRemoveUserFromGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRemoveUserFromGroup Operation - - - - Resets the specified user's password in a user pool as an administrator. Works on - any user. - - - - When a developer calls this API, the current password is invalidated, so it must be - changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException - exception back and should direct the user down the flow to reset the password, which - is the same as the forgot password flow. In addition, if the user pool has phone verification - selected and a verified phone number exists for the user, or if email verification - is selected and a verified email exists for the user, calling this API will also result - in sending a message to the end user with the code to change their password. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminResetUserPassword service method. - - The response from the AdminResetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminResetUserPassword Operation - - - - Resets the specified user's password in a user pool as an administrator. Works on - any user. - - - - When a developer calls this API, the current password is invalidated, so it must be - changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException - exception back and should direct the user down the flow to reset the password, which - is the same as the forgot password flow. In addition, if the user pool has phone verification - selected and a verified phone number exists for the user, or if email verification - is selected and a verified email exists for the user, calling this API will also result - in sending a message to the end user with the code to change their password. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminResetUserPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminResetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminResetUserPassword Operation - - - - Responds to an authentication challenge, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRespondToAuthChallenge service method. - - The response from the AdminRespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRespondToAuthChallenge Operation - - - - Responds to an authentication challenge, as an administrator. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminRespondToAuthChallenge service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminRespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminRespondToAuthChallenge Operation - - - - Sets the user's multi-factor authentication (MFA) preference, including which MFA - options are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. - - Container for the necessary parameters to execute the AdminSetUserMFAPreference service method. - - The response from the AdminSetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserMFAPreference Operation - - - - Sets the user's multi-factor authentication (MFA) preference, including which MFA - options are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. - - Container for the necessary parameters to execute the AdminSetUserMFAPreference service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserMFAPreference Operation - - - - Sets the specified user's password in a user pool as an administrator. Works on any - user. - - - - The password can be temporary or permanent. If it is temporary, the user status will - be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries - to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED - challenge. If the user does not sign in before it expires, the user will not be able - to sign in and their password will need to be reset by an administrator. - - - - Once the user has set a new password, or the password is permanent, the user status - will be set to Confirmed. - - - Container for the necessary parameters to execute the AdminSetUserPassword service method. - - The response from the AdminSetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserPassword Operation - - - - Sets the specified user's password in a user pool as an administrator. Works on any - user. - - - - The password can be temporary or permanent. If it is temporary, the user status will - be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries - to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED - challenge. If the user does not sign in before it expires, the user will not be able - to sign in and their password will need to be reset by an administrator. - - - - Once the user has set a new password, or the password is permanent, the user status - will be set to Confirmed. - - - Container for the necessary parameters to execute the AdminSetUserPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserPassword Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use AdminSetUserMFAPreference - instead. - - Container for the necessary parameters to execute the AdminSetUserSettings service method. - - The response from the AdminSetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserSettings Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use AdminSetUserMFAPreference - instead. - - Container for the necessary parameters to execute the AdminSetUserSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminSetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminSetUserSettings Operation - - - - Provides feedback for an authentication event as to whether it was from a valid user. - This feedback is used for improving the risk evaluation decision for the user pool - as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the AdminUpdateAuthEventFeedback service method. - - The response from the AdminUpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminUpdateAuthEventFeedback Operation - - - - Provides feedback for an authentication event as to whether it was from a valid user. - This feedback is used for improving the risk evaluation decision for the user pool - as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the AdminUpdateAuthEventFeedback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for AdminUpdateAuthEventFeedback Operation - - - - Updates the device status as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateDeviceStatus service method. - - The response from the AdminUpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateDeviceStatus Operation - - - - Updates the device status as an administrator. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateDeviceStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateDeviceStatus Operation - - - - Updates the specified user's attributes, including developer attributes, as an administrator. - Works on any user. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - In addition to updating user attributes, this API can also be used to mark phone and - email as verified. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateUserAttributes service method. - - The response from the AdminUpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateUserAttributes Operation - - - - Updates the specified user's attributes, including developer attributes, as an administrator. - Works on any user. - - - - For custom attributes, you must prepend the custom: prefix to the attribute - name. - - - - In addition to updating user attributes, this API can also be used to mark phone and - email as verified. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUpdateUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUpdateUserAttributes Operation - - - - Signs out users from all devices, as an administrator. It also invalidates all refresh - tokens issued to a user. The user's current access and Id tokens remain valid until - their expiry. Access and Id tokens expire one hour after they are issued. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUserGlobalSignOut service method. - - The response from the AdminUserGlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUserGlobalSignOut Operation - - - - Signs out users from all devices, as an administrator. It also invalidates all refresh - tokens issued to a user. The user's current access and Id tokens remain valid until - their expiry. Access and Id tokens expire one hour after they are issued. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the AdminUserGlobalSignOut service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AdminUserGlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - REST API Reference for AdminUserGlobalSignOut Operation - - - - Returns a unique generated shared secret key code for the user account. The request - takes an access token or a session string, but not both. - - - - Calling AssociateSoftwareToken immediately disassociates the existing software token - from the user account. If the user doesn't subsequently verify the software token, - their account is essentially set up to authenticate without MFA. If MFA config is - set to Optional at the user pool level, the user can then login without MFA. However, - if MFA is set to Required for the user pool, the user will be asked to setup a new - software token MFA during sign in. - - - - Container for the necessary parameters to execute the AssociateSoftwareToken service method. - - The response from the AssociateSoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - REST API Reference for AssociateSoftwareToken Operation - - - - Returns a unique generated shared secret key code for the user account. The request - takes an access token or a session string, but not both. - - - - Calling AssociateSoftwareToken immediately disassociates the existing software token - from the user account. If the user doesn't subsequently verify the software token, - their account is essentially set up to authenticate without MFA. If MFA config is - set to Optional at the user pool level, the user can then login without MFA. However, - if MFA is set to Required for the user pool, the user will be asked to setup a new - software token MFA during sign in. - - - - Container for the necessary parameters to execute the AssociateSoftwareToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssociateSoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - REST API Reference for AssociateSoftwareToken Operation - - - - Changes the password for a specified user in a user pool. - - Container for the necessary parameters to execute the ChangePassword service method. - - The response from the ChangePassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ChangePassword Operation - - - - Changes the password for a specified user in a user pool. - - Container for the necessary parameters to execute the ChangePassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ChangePassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ChangePassword Operation - - - - Confirms tracking of the device. This API call is the call that begins device tracking. - - Container for the necessary parameters to execute the ConfirmDevice service method. - - The response from the ConfirmDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmDevice Operation - - - - Confirms tracking of the device. This API call is the call that begins device tracking. - - Container for the necessary parameters to execute the ConfirmDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmDevice Operation - - - - Allows a user to enter a confirmation code to reset a forgotten password. - - Container for the necessary parameters to execute the ConfirmForgotPassword service method. - - The response from the ConfirmForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmForgotPassword Operation - - - - Allows a user to enter a confirmation code to reset a forgotten password. - - Container for the necessary parameters to execute the ConfirmForgotPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmForgotPassword Operation - - - - Confirms registration of a user and handles the existing alias from a previous user. - - Container for the necessary parameters to execute the ConfirmSignUp service method. - - The response from the ConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmSignUp Operation - - - - Confirms registration of a user and handles the existing alias from a previous user. - - Container for the necessary parameters to execute the ConfirmSignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ConfirmSignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many failed attempts for a given - action (e.g., sign in). - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ConfirmSignUp Operation - - - - Creates a new group in the specified user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the CreateGroup service method. - - The response from the CreateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters a group that already exists - in the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateGroup Operation - - - - Creates a new group in the specified user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the CreateGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters a group that already exists - in the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateGroup Operation - - - - Creates an identity provider for a user pool. - - Container for the necessary parameters to execute the CreateIdentityProvider service method. - - The response from the CreateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when the provider is already supported by the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateIdentityProvider Operation - - - - Creates an identity provider for a user pool. - - Container for the necessary parameters to execute the CreateIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when the provider is already supported by the user pool. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateIdentityProvider Operation - - - - Creates a new OAuth2.0 resource server and defines custom scopes in it. - - Container for the necessary parameters to execute the CreateResourceServer service method. - - The response from the CreateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateResourceServer Operation - - - - Creates a new OAuth2.0 resource server and defines custom scopes in it. - - Container for the necessary parameters to execute the CreateResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateResourceServer Operation - - - - Creates the user import job. - - Container for the necessary parameters to execute the CreateUserImportJob service method. - - The response from the CreateUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserImportJob Operation - - - - Creates the user import job. - - Container for the necessary parameters to execute the CreateUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserImportJob Operation - - - - Creates a new Amazon Cognito user pool and sets the password policy for the pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the CreateUserPool service method. - - The response from the CreateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for CreateUserPool Operation - - - - Creates a new Amazon Cognito user pool and sets the password policy for the pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the CreateUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for CreateUserPool Operation - - - - Creates the user pool client. - - - - When you create a new user pool client, token revocation is automatically enabled. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the CreateUserPoolClient service method. - - The response from the CreateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserPoolClient Operation - - - - Creates the user pool client. - - - - When you create a new user pool client, token revocation is automatically enabled. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the CreateUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for CreateUserPoolClient Operation - - - - Creates a new domain for a user pool. - - Container for the necessary parameters to execute the CreateUserPoolDomain service method. - - The response from the CreateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for CreateUserPoolDomain Operation - - - - Creates a new domain for a user pool. - - Container for the necessary parameters to execute the CreateUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for CreateUserPoolDomain Operation - - - - Deletes a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the DeleteGroup service method. - - The response from the DeleteGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteGroup Operation - - - - Deletes a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the DeleteGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteGroup Operation - - - - Deletes an identity provider for a user pool. - - Container for the necessary parameters to execute the DeleteIdentityProvider service method. - - The response from the DeleteIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for DeleteIdentityProvider Operation - - - - Deletes an identity provider for a user pool. - - Container for the necessary parameters to execute the DeleteIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for DeleteIdentityProvider Operation - - - - Deletes a resource server. - - Container for the necessary parameters to execute the DeleteResourceServer service method. - - The response from the DeleteResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteResourceServer Operation - - - - Deletes a resource server. - - Container for the necessary parameters to execute the DeleteResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteResourceServer Operation - - - - Allows a user to delete himself or herself. - - Container for the necessary parameters to execute the DeleteUser service method. - - The response from the DeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUser Operation - - - - Allows a user to delete himself or herself. - - Container for the necessary parameters to execute the DeleteUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUser Operation - - - - Deletes the attributes for a user. - - Container for the necessary parameters to execute the DeleteUserAttributes service method. - - The response from the DeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUserAttributes Operation - - - - Deletes the attributes for a user. - - Container for the necessary parameters to execute the DeleteUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for DeleteUserAttributes Operation - - - - Deletes the specified Amazon Cognito user pool. - - Container for the necessary parameters to execute the DeleteUserPool service method. - - The response from the DeleteUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for DeleteUserPool Operation - - - - Deletes the specified Amazon Cognito user pool. - - Container for the necessary parameters to execute the DeleteUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - REST API Reference for DeleteUserPool Operation - - - - Allows the developer to delete the user pool client. - - Container for the necessary parameters to execute the DeleteUserPoolClient service method. - - The response from the DeleteUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteUserPoolClient Operation - - - - Allows the developer to delete the user pool client. - - Container for the necessary parameters to execute the DeleteUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DeleteUserPoolClient Operation - - - - Deletes a domain for a user pool. - - Container for the necessary parameters to execute the DeleteUserPoolDomain service method. - - The response from the DeleteUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DeleteUserPoolDomain Operation - - - - Deletes a domain for a user pool. - - Container for the necessary parameters to execute the DeleteUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DeleteUserPoolDomain Operation - - - - Gets information about a specific identity provider. - - Container for the necessary parameters to execute the DescribeIdentityProvider service method. - - The response from the DescribeIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeIdentityProvider Operation - - - - Gets information about a specific identity provider. - - Container for the necessary parameters to execute the DescribeIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeIdentityProvider Operation - - - - Describes a resource server. - - Container for the necessary parameters to execute the DescribeResourceServer service method. - - The response from the DescribeResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeResourceServer Operation - - - - Describes a resource server. - - Container for the necessary parameters to execute the DescribeResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeResourceServer Operation - - - - Describes the risk configuration. - - Container for the necessary parameters to execute the DescribeRiskConfiguration service method. - - The response from the DescribeRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for DescribeRiskConfiguration Operation - - - - Describes the risk configuration. - - Container for the necessary parameters to execute the DescribeRiskConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for DescribeRiskConfiguration Operation - - - - Describes the user import job. - - Container for the necessary parameters to execute the DescribeUserImportJob service method. - - The response from the DescribeUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserImportJob Operation - - - - Describes the user import job. - - Container for the necessary parameters to execute the DescribeUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserImportJob Operation - - - - Returns the configuration information and metadata of the specified user pool. - - Container for the necessary parameters to execute the DescribeUserPool service method. - - The response from the DescribeUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for DescribeUserPool Operation - - - - Returns the configuration information and metadata of the specified user pool. - - Container for the necessary parameters to execute the DescribeUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for DescribeUserPool Operation - - - - Client method for returning the configuration information and metadata of the specified - user pool app client. - - Container for the necessary parameters to execute the DescribeUserPoolClient service method. - - The response from the DescribeUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserPoolClient Operation - - - - Client method for returning the configuration information and metadata of the specified - user pool app client. - - Container for the necessary parameters to execute the DescribeUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for DescribeUserPoolClient Operation - - - - Gets information about a domain. - - Container for the necessary parameters to execute the DescribeUserPoolDomain service method. - - The response from the DescribeUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DescribeUserPoolDomain Operation - - - - Gets information about a domain. - - Container for the necessary parameters to execute the DescribeUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for DescribeUserPoolDomain Operation - - - - Forgets the specified device. - - Container for the necessary parameters to execute the ForgetDevice service method. - - The response from the ForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgetDevice Operation - - - - Forgets the specified device. - - Container for the necessary parameters to execute the ForgetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ForgetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgetDevice Operation - - - - Calling this API causes a message to be sent to the end user with a confirmation code - that is required to change the user's password. For the Username parameter, - you can use the username or user alias. The method used to send the confirmation code - is sent according to the specified AccountRecoverySetting. For more information, see - Recovering - User Accounts in the Amazon Cognito Developer Guide. If neither a verified - phone number nor a verified email exists, an InvalidParameterException - is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ForgotPassword service method. - - The response from the ForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgotPassword Operation - - - - Calling this API causes a message to be sent to the end user with a confirmation code - that is required to change the user's password. For the Username parameter, - you can use the username or user alias. The method used to send the confirmation code - is sent according to the specified AccountRecoverySetting. For more information, see - Recovering - User Accounts in the Amazon Cognito Developer Guide. If neither a verified - phone number nor a verified email exists, an InvalidParameterException - is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ForgotPassword service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ForgotPassword service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ForgotPassword Operation - - - - Gets the header information for the .csv file to be used as input for the user import - job. - - Container for the necessary parameters to execute the GetCSVHeader service method. - - The response from the GetCSVHeader service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetCSVHeader Operation - - - - Gets the header information for the .csv file to be used as input for the user import - job. - - Container for the necessary parameters to execute the GetCSVHeader service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCSVHeader service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetCSVHeader Operation - - - - Gets the device. - - Container for the necessary parameters to execute the GetDevice service method. - - The response from the GetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetDevice Operation - - - - Gets the device. - - Container for the necessary parameters to execute the GetDevice service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetDevice service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetDevice Operation - - - - Gets a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the GetGroup service method. - - The response from the GetGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetGroup Operation - - - - Gets a group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the GetGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetGroup Operation - - - - Gets the specified identity provider. - - Container for the necessary parameters to execute the GetIdentityProviderByIdentifier service method. - - The response from the GetIdentityProviderByIdentifier service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetIdentityProviderByIdentifier Operation - - - - Gets the specified identity provider. - - Container for the necessary parameters to execute the GetIdentityProviderByIdentifier service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetIdentityProviderByIdentifier service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetIdentityProviderByIdentifier Operation - - - - This method takes a user pool ID, and returns the signing certificate. - - Container for the necessary parameters to execute the GetSigningCertificate service method. - - The response from the GetSigningCertificate service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for GetSigningCertificate Operation - - - - This method takes a user pool ID, and returns the signing certificate. - - Container for the necessary parameters to execute the GetSigningCertificate service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSigningCertificate service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - REST API Reference for GetSigningCertificate Operation - - - - Gets the UI Customization information for a particular app client's app UI, if there - is something set. If nothing is set for the particular client, but there is an existing - pool level customization (app clientId will be ALL), then - that is returned. If nothing is present, then an empty shape is returned. - - Container for the necessary parameters to execute the GetUICustomization service method. - - The response from the GetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUICustomization Operation - - - - Gets the UI Customization information for a particular app client's app UI, if there - is something set. If nothing is set for the particular client, but there is an existing - pool level customization (app clientId will be ALL), then - that is returned. If nothing is present, then an empty shape is returned. - - Container for the necessary parameters to execute the GetUICustomization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUICustomization Operation - - - - Gets the user attributes and metadata for a user. - - Container for the necessary parameters to execute the GetUser service method. - - The response from the GetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUser Operation - - - - Gets the user attributes and metadata for a user. - - Container for the necessary parameters to execute the GetUser service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUser service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUser Operation - - - - Gets the user attribute verification code for the specified attribute name. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the GetUserAttributeVerificationCode service method. - - The response from the GetUserAttributeVerificationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUserAttributeVerificationCode Operation - - - - Gets the user attribute verification code for the specified attribute name. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the GetUserAttributeVerificationCode service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUserAttributeVerificationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for GetUserAttributeVerificationCode Operation - - - - Gets the user pool multi-factor authentication (MFA) configuration. - - Container for the necessary parameters to execute the GetUserPoolMfaConfig service method. - - The response from the GetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUserPoolMfaConfig Operation - - - - Gets the user pool multi-factor authentication (MFA) configuration. - - Container for the necessary parameters to execute the GetUserPoolMfaConfig service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for GetUserPoolMfaConfig Operation - - - - Signs out users from all devices. It also invalidates all refresh tokens issued to - a user. The user's current access and Id tokens remain valid until their expiry. Access - and Id tokens expire one hour after they are issued. - - Container for the necessary parameters to execute the GlobalSignOut service method. - - The response from the GlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - REST API Reference for GlobalSignOut Operation - - - - Signs out users from all devices. It also invalidates all refresh tokens issued to - a user. The user's current access and Id tokens remain valid until their expiry. Access - and Id tokens expire one hour after they are issued. - - Container for the necessary parameters to execute the GlobalSignOut service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GlobalSignOut service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - REST API Reference for GlobalSignOut Operation - - - - Initiates the authentication flow. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the InitiateAuth service method. - - The response from the InitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for InitiateAuth Operation - - - - Initiates the authentication flow. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the InitiateAuth service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateAuth service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for InitiateAuth Operation - - - - Lists the devices. - - Container for the necessary parameters to execute the ListDevices service method. - - The response from the ListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ListDevices Operation - - - - Lists the devices. - - Container for the necessary parameters to execute the ListDevices service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListDevices service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for ListDevices Operation - - - - Lists the groups associated with a user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListGroups service method. - - The response from the ListGroups service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListGroups Operation - - - - Lists the groups associated with a user pool. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListGroups service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGroups service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListGroups Operation - - - - Lists information about all identity providers for a user pool. - - Container for the necessary parameters to execute the ListIdentityProviders service method. - - The response from the ListIdentityProviders service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListIdentityProviders Operation - - - - Lists information about all identity providers for a user pool. - - Container for the necessary parameters to execute the ListIdentityProviders service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListIdentityProviders service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListIdentityProviders Operation - - - - Lists the resource servers for a user pool. - - Container for the necessary parameters to execute the ListResourceServers service method. - - The response from the ListResourceServers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListResourceServers Operation - - - - Lists the resource servers for a user pool. - - Container for the necessary parameters to execute the ListResourceServers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListResourceServers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListResourceServers Operation - - - - Lists the tags that are assigned to an Amazon Cognito user pool. - - - - A tag is a label that you can apply to user pools to categorize and manage them in - different ways, such as by purpose, owner, environment, or other criteria. - - - - You can use this action up to 10 times per second, per account. - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - The response from the ListTagsForResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListTagsForResource Operation - - - - Lists the tags that are assigned to an Amazon Cognito user pool. - - - - A tag is a label that you can apply to user pools to categorize and manage them in - different ways, such as by purpose, owner, environment, or other criteria. - - - - You can use this action up to 10 times per second, per account. - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTagsForResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListTagsForResource Operation - - - - Lists the user import jobs. - - Container for the necessary parameters to execute the ListUserImportJobs service method. - - The response from the ListUserImportJobs service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserImportJobs Operation - - - - Lists the user import jobs. - - Container for the necessary parameters to execute the ListUserImportJobs service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserImportJobs service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserImportJobs Operation - - - - Lists the clients that have been created for the specified user pool. - - Container for the necessary parameters to execute the ListUserPoolClients service method. - - The response from the ListUserPoolClients service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPoolClients Operation - - - - Lists the clients that have been created for the specified user pool. - - Container for the necessary parameters to execute the ListUserPoolClients service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserPoolClients service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPoolClients Operation - - - - Lists the user pools associated with an AWS account. - - Container for the necessary parameters to execute the ListUserPools service method. - - The response from the ListUserPools service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPools Operation - - - - Lists the user pools associated with an AWS account. - - Container for the necessary parameters to execute the ListUserPools service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUserPools service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUserPools Operation - - - - Lists the users in the Amazon Cognito user pool. - - Container for the necessary parameters to execute the ListUsers service method. - - The response from the ListUsers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsers Operation - - - - Lists the users in the Amazon Cognito user pool. - - Container for the necessary parameters to execute the ListUsers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUsers service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsers Operation - - - - Lists the users in the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListUsersInGroup service method. - - The response from the ListUsersInGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsersInGroup Operation - - - - Lists the users in the specified group. - - - - Calling this action requires developer credentials. - - - Container for the necessary parameters to execute the ListUsersInGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListUsersInGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for ListUsersInGroup Operation - - - - Resends the confirmation (for confirmation of registration) to a specific user in - the user pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ResendConfirmationCode service method. - - The response from the ResendConfirmationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ResendConfirmationCode Operation - - - - Resends the confirmation (for confirmation of registration) to a specific user in - the user pool. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the ResendConfirmationCode service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResendConfirmationCode service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not found. - - REST API Reference for ResendConfirmationCode Operation - - - - Responds to the authentication challenge. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the RespondToAuthChallenge service method. - - The response from the RespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for RespondToAuthChallenge Operation - - - - Responds to the authentication challenge. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the RespondToAuthChallenge service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RespondToAuthChallenge service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication - (MFA) method. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for RespondToAuthChallenge Operation - - - - Revokes all of the access tokens generated by the specified refresh token. After the - token is revoked, you can not use the revoked token to access Cognito authenticated - APIs. - - Container for the necessary parameters to execute the RevokeToken service method. - - The response from the RevokeToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the request is not authorized. This can happen due to - an invalid access token in the request. - - - This exception is thrown when you attempt to perform an operation that is not enabled - for the user pool client. - - - This exception is thrown when an unsupported token is passed to an operation. - - REST API Reference for RevokeToken Operation - - - - Revokes all of the access tokens generated by the specified refresh token. After the - token is revoked, you can not use the revoked token to access Cognito authenticated - APIs. - - Container for the necessary parameters to execute the RevokeToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RevokeToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the request is not authorized. This can happen due to - an invalid access token in the request. - - - This exception is thrown when you attempt to perform an operation that is not enabled - for the user pool client. - - - This exception is thrown when an unsupported token is passed to an operation. - - REST API Reference for RevokeToken Operation - - - - Configures actions on detected risks. To delete the risk configuration for UserPoolId - or ClientId, pass null values for all four configuration types. - - - - To enable Amazon Cognito advanced security features, update the user pool to include - the UserPoolAddOns keyAdvancedSecurityMode. - - - Container for the necessary parameters to execute the SetRiskConfiguration service method. - - The response from the SetRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for SetRiskConfiguration Operation - - - - Configures actions on detected risks. To delete the risk configuration for UserPoolId - or ClientId, pass null values for all four configuration types. - - - - To enable Amazon Cognito advanced security features, update the user pool to include - the UserPoolAddOns keyAdvancedSecurityMode. - - - Container for the necessary parameters to execute the SetRiskConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetRiskConfiguration service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for SetRiskConfiguration Operation - - - - Sets the UI customization information for a user pool's built-in app UI. - - - - You can specify app UI customization settings for a single client (with a specific - clientId) or for all clients (by setting the clientId to - ALL). If you specify ALL, the default configuration will - be used for every client that has no UI customization set previously. If you specify - UI customization settings for a particular client, it will no longer fall back to - the ALL configuration. - - - - To use this API, your user pool must have a domain associated with it. Otherwise, - there is no place to host the app's pages, and the service will throw an error. - - - - Container for the necessary parameters to execute the SetUICustomization service method. - - The response from the SetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUICustomization Operation - - - - Sets the UI customization information for a user pool's built-in app UI. - - - - You can specify app UI customization settings for a single client (with a specific - clientId) or for all clients (by setting the clientId to - ALL). If you specify ALL, the default configuration will - be used for every client that has no UI customization set previously. If you specify - UI customization settings for a particular client, it will no longer fall back to - the ALL configuration. - - - - To use this API, your user pool must have a domain associated with it. Otherwise, - there is no place to host the app's pages, and the service will throw an error. - - - - Container for the necessary parameters to execute the SetUICustomization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUICustomization service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUICustomization Operation - - - - Set the user's multi-factor authentication (MFA) method preference, including which - MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. If an MFA type is enabled for - a user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. If you would like MFA to be - applied selectively based on the assessed risk level of sign in attempts, disable - MFA for users and turn on Adaptive Authentication for the user pool. - - Container for the necessary parameters to execute the SetUserMFAPreference service method. - - The response from the SetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserMFAPreference Operation - - - - Set the user's multi-factor authentication (MFA) method preference, including which - MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. - The preferred MFA factor will be used to authenticate a user if multiple factors are - enabled. If multiple options are enabled and no preference is set, a challenge to - choose an MFA option will be returned during sign in. If an MFA type is enabled for - a user, the user will be prompted for MFA during all sign in attempts, unless device - tracking is turned on and the device has been trusted. If you would like MFA to be - applied selectively based on the assessed risk level of sign in attempts, disable - MFA for users and turn on Adaptive Authentication for the user pool. - - Container for the necessary parameters to execute the SetUserMFAPreference service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserMFAPreference service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserMFAPreference Operation - - - - Set the user pool multi-factor authentication (MFA) configuration. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SetUserPoolMfaConfig service method. - - The response from the SetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUserPoolMfaConfig Operation - - - - Set the user pool multi-factor authentication (MFA) configuration. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SetUserPoolMfaConfig service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserPoolMfaConfig service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for SetUserPoolMfaConfig Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use SetUserMFAPreference - instead. - - Container for the necessary parameters to execute the SetUserSettings service method. - - The response from the SetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserSettings Operation - - - - This action is no longer supported. You can use it to configure only SMS MFA. - You can't use it to configure TOTP software token MFA. To configure either type of - MFA, use SetUserMFAPreference - instead. - - Container for the necessary parameters to execute the SetUserSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SetUserSettings service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for SetUserSettings Operation - - - - Registers the user in the specified user pool and creates a user name, password, and - user attributes. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SignUp service method. - - The response from the SignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - REST API Reference for SignUp Operation - - - - Registers the user in the specified user pool and creates a user name, password, and - user attributes. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the SignUp service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SignUp service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the Amazon Cognito service encounters an invalid password. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when Amazon Cognito encounters a user name that already exists - in the user pool. - - REST API Reference for SignUp Operation - - - - Starts the user import. - - Container for the necessary parameters to execute the StartUserImportJob service method. - - The response from the StartUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StartUserImportJob Operation - - - - Starts the user import. - - Container for the necessary parameters to execute the StartUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StartUserImportJob Operation - - - - Stops the user import job. - - Container for the necessary parameters to execute the StopUserImportJob service method. - - The response from the StopUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StopUserImportJob Operation - - - - Stops the user import job. - - Container for the necessary parameters to execute the StopUserImportJob service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopUserImportJob service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a precondition is not met. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for StopUserImportJob Operation - - - - Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - Each tag consists of a key and value, both of which you define. A key is a general - category for more specific values. For example, if you have two versions of a user - pool, one for testing and another for production, you might assign an Environment - tag key to both user pools. The value of this key might be Test for one - user pool and Production for the other. - - - - Tags are useful for cost tracking and access control. You can activate your tags so - that they appear on the Billing and Cost Management console, where you can track the - costs associated with your user pools. In an IAM policy, you can constrain permissions - for user pools based on specific tags or tag values. - - - - You can use this action up to 5 times per second, per account. A user pool can have - as many as 50 tags. - - - Container for the necessary parameters to execute the TagResource service method. - - The response from the TagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for TagResource Operation - - - - Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can - use to categorize and manage user pools in different ways, such as by purpose, owner, - environment, or other criteria. - - - - Each tag consists of a key and value, both of which you define. A key is a general - category for more specific values. For example, if you have two versions of a user - pool, one for testing and another for production, you might assign an Environment - tag key to both user pools. The value of this key might be Test for one - user pool and Production for the other. - - - - Tags are useful for cost tracking and access control. You can activate your tags so - that they appear on the Billing and Cost Management console, where you can track the - costs associated with your user pools. In an IAM policy, you can constrain permissions - for user pools based on specific tags or tag values. - - - - You can use this action up to 5 times per second, per account. A user pool can have - as many as 50 tags. - - - Container for the necessary parameters to execute the TagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for TagResource Operation - - - - Removes the specified tags from an Amazon Cognito user pool. You can use this action - up to 5 times per second, per account - - Container for the necessary parameters to execute the UntagResource service method. - - The response from the UntagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UntagResource Operation - - - - Removes the specified tags from an Amazon Cognito user pool. You can use this action - up to 5 times per second, per account - - Container for the necessary parameters to execute the UntagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UntagResource service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UntagResource Operation - - - - Provides the feedback for an authentication event whether it was from a valid user - or not. This feedback is used for improving the risk evaluation decision for the user - pool as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the UpdateAuthEventFeedback service method. - - The response from the UpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for UpdateAuthEventFeedback Operation - - - - Provides the feedback for an authentication event whether it was from a valid user - or not. This feedback is used for improving the risk evaluation decision for the user - pool as part of Amazon Cognito advanced security. - - Container for the necessary parameters to execute the UpdateAuthEventFeedback service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateAuthEventFeedback service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not found. - - - This exception is thrown when user pool add-ons are not enabled. - - REST API Reference for UpdateAuthEventFeedback Operation - - - - Updates the device status. - - Container for the necessary parameters to execute the UpdateDeviceStatus service method. - - The response from the UpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateDeviceStatus Operation - - - - Updates the device status. - - Container for the necessary parameters to execute the UpdateDeviceStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateDeviceStatus service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateDeviceStatus Operation - - - - Updates the specified group with the specified attributes. - - - - Calling this action requires developer credentials. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateGroup service method. - - The response from the UpdateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateGroup Operation - - - - Updates the specified group with the specified attributes. - - - - Calling this action requires developer credentials. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGroup service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateGroup Operation - - - - Updates identity provider information for a user pool. - - Container for the necessary parameters to execute the UpdateIdentityProvider service method. - - The response from the UpdateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for UpdateIdentityProvider Operation - - - - Updates identity provider information for a user pool. - - Container for the necessary parameters to execute the UpdateIdentityProvider service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateIdentityProvider service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the specified identifier is not supported. - - REST API Reference for UpdateIdentityProvider Operation - - - - Updates the name and scopes of resource server. All other fields are read-only. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateResourceServer service method. - - The response from the UpdateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateResourceServer Operation - - - - Updates the name and scopes of resource server. All other fields are read-only. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - Container for the necessary parameters to execute the UpdateResourceServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateResourceServer service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateResourceServer Operation - - - - Allows a user to update a specific attribute (one at a time). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserAttributes service method. - - The response from the UpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateUserAttributes Operation - - - - Allows a user to update a specific attribute (one at a time). - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserAttributes service method, as returned by CognitoIdentityProvider. - - This exception is thrown when a user tries to confirm the account with an email or - phone number that has already been supplied as an alias from a different account. - This exception tells user that an account with this email or phone already exists. - - - This exception is thrown when a verification code fails to deliver successfully. - - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid AWS - Lambda response. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when the Amazon Cognito service encounters an unexpected - exception with the AWS Lambda service. - - - This exception is thrown when the Amazon Cognito service encounters a user validation - exception with the AWS Lambda service. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for UpdateUserAttributes Operation - - - - Updates the specified user pool with the specified attributes. You can get a list - of the current user pool settings using DescribeUserPool. - If you don't provide a value for an attribute, it will be set to the default value. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserPool service method. - - The response from the UpdateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for UpdateUserPool Operation - - - - Updates the specified user pool with the specified attributes. You can get a list - of the current user pool settings using DescribeUserPool. - If you don't provide a value for an attribute, it will be set to the default value. - - - - This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom - carriers require that you register an origination phone number before you can send - SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, - you must register a phone number with Amazon - Pinpoint. Cognito will use the the registered number automatically. Otherwise, - Cognito users that must receive SMS messages might be unable to sign up, activate - their accounts, or sign in. - - - - If you have never used SMS text messages with Amazon Cognito or any other AWS service, - Amazon SNS might place your account in SMS sandbox. In sandbox - mode , you’ll have limitations, such as sending messages to only verified - phone numbers. After testing in the sandbox environment, you can move out of the SMS - sandbox and into production. For more information, see - SMS message settings for Cognito User Pools in the Amazon Cognito Developer - Guide. - - - - Container for the necessary parameters to execute the UpdateUserPool service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPool service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when Amazon Cognito is not allowed to use your email identity. - HTTP status code: 400. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is returned when the role provided for SMS configuration does not have - permission to publish using Amazon SNS. - - - This exception is thrown when the trust relationship is invalid for the role provided - for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com - or the external ID provided in the role does not match what is provided in the SMS - configuration for the user pool. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when you are trying to modify a user pool while a user import - job is in progress for that pool. - - - This exception is thrown when a user pool tag cannot be set or updated. - - REST API Reference for UpdateUserPool Operation - - - - Updates the specified user pool app client with the specified attributes. You can - get a list of the current user pool app client settings using DescribeUserPoolClient. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - You can also use this operation to enable token revocation for user pool clients. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the UpdateUserPoolClient service method. - - The response from the UpdateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolClient Operation - - - - Updates the specified user pool app client with the specified attributes. You can - get a list of the current user pool app client settings using DescribeUserPoolClient. - - - - If you don't provide a value for an attribute, it will be set to the default value. - - - - You can also use this operation to enable token revocation for user pool clients. - For more information about revoking tokens, see RevokeToken. - - - Container for the necessary parameters to execute the UpdateUserPoolClient service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPoolClient service method, as returned by CognitoIdentityProvider. - - This exception is thrown if two or more modifications are happening concurrently. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the specified OAuth flow is invalid. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the specified scope does not exist. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolClient Operation - - - - Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your - user pool. - - - - You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate - to Amazon Cognito. You cannot use it to change the domain for a user pool. - - - - A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up - and sign-in pages for your application. When you set up a custom domain, you provide - a certificate that you manage with AWS Certificate Manager (ACM). When necessary, - you can use this operation to change the certificate that you applied to your custom - domain. - - - - Usually, this is unnecessary following routine certificate renewal with ACM. When - you renew your existing certificate in ACM, the ARN for your certificate remains the - same, and your custom domain uses the new certificate automatically. - - - - However, if you replace your existing certificate with a new one, ACM gives the new - certificate a new ARN. To apply the new certificate to your custom domain, you must - provide this ARN to Amazon Cognito. - - - - When you add your new certificate in ACM, you must choose US East (N. Virginia) as - the AWS Region. - - - - After you submit your request, Amazon Cognito requires up to 1 hour to distribute - your new certificate to your custom domain. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - Container for the necessary parameters to execute the UpdateUserPoolDomain service method. - - The response from the UpdateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolDomain Operation - - - - Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your - user pool. - - - - You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate - to Amazon Cognito. You cannot use it to change the domain for a user pool. - - - - A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up - and sign-in pages for your application. When you set up a custom domain, you provide - a certificate that you manage with AWS Certificate Manager (ACM). When necessary, - you can use this operation to change the certificate that you applied to your custom - domain. - - - - Usually, this is unnecessary following routine certificate renewal with ACM. When - you renew your existing certificate in ACM, the ARN for your certificate remains the - same, and your custom domain uses the new certificate automatically. - - - - However, if you replace your existing certificate with a new one, ACM gives the new - certificate a new ARN. To apply the new certificate to your custom domain, you must - provide this ARN to Amazon Cognito. - - - - When you add your new certificate in ACM, you must choose US East (N. Virginia) as - the AWS Region. - - - - After you submit your request, Amazon Cognito requires up to 1 hour to distribute - your new certificate to your custom domain. - - - - For more information about adding a custom domain to your user pool, see Using - Your Own Domain for the Hosted UI. - - - Container for the necessary parameters to execute the UpdateUserPoolDomain service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateUserPoolDomain service method, as returned by CognitoIdentityProvider. - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - REST API Reference for UpdateUserPoolDomain Operation - - - - Use this API to register a user's entered TOTP code and mark the user's software token - MFA status as "verified" if successful. The request takes an access token or a session - string, but not both. - - Container for the necessary parameters to execute the VerifySoftwareToken service method. - - The response from the VerifySoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown when there is a code mismatch and the service fails to configure - the software token TOTP multi-factor authentication (MFA). - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifySoftwareToken Operation - - - - Use this API to register a user's entered TOTP code and mark the user's software token - MFA status as "verified" if successful. The request takes an access token or a session - string, but not both. - - Container for the necessary parameters to execute the VerifySoftwareToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the VerifySoftwareToken service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown when there is a code mismatch and the service fails to configure - the software token TOTP multi-factor authentication (MFA). - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when the user pool configuration is invalid. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the software token TOTP multi-factor authentication - (MFA) is not enabled for the user pool. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifySoftwareToken Operation - - - - Verifies the specified user attributes in the user pool. - - Container for the necessary parameters to execute the VerifyUserAttribute service method. - - The response from the VerifyUserAttribute service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifyUserAttribute Operation - - - - Verifies the specified user attributes in the user pool. - - Container for the necessary parameters to execute the VerifyUserAttribute service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the VerifyUserAttribute service method, as returned by CognitoIdentityProvider. - - This exception is thrown if the provided code does not match what the server was expecting. - - - This exception is thrown if a code has expired. - - - This exception is thrown when Amazon Cognito encounters an internal error. - - - This exception is thrown when the Amazon Cognito service encounters an invalid parameter. - - - This exception is thrown when a user exceeds the limit for a requested AWS resource. - - - This exception is thrown when a user is not authorized. - - - This exception is thrown when a password reset is required. - - - This exception is thrown when the Amazon Cognito service cannot find the requested - resource. - - - This exception is thrown when the user has made too many requests for a given operation. - - - This exception is thrown when a user is not confirmed successfully. - - - This exception is thrown when a user is not found. - - REST API Reference for VerifyUserAttribute Operation - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.dll.meta deleted file mode 100644 index e7093007..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 43e9a8139ea672d4d8426ebdcf063d2e -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml deleted file mode 100644 index 3a99aee9..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml +++ /dev/null @@ -1,16221 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Condition key for the account id of the source specified - in a request. - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - Constructs a new instance of the AmazonClientException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Constructs a new instance of the AmazonDateTimeUnmarshallingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Constructs a new instance of the AmazonSimpleDBException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Collection used to indicate if the property was initialized by the SDK. - - - - - - Collection used to indicate if the property was initialized by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Legacy version (no longer supported) - 2 - Default version. Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing - data integrity check on this request. - If using SigV4, the DisablePayloadSigning flag controls if the payload should be - signed on a request by request basis. By default this flag is null which will use the - default client behavior. The default client behavior is to sign the payload. When - DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. - Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS - connection. - Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may - be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies - to Amazon S3 PutObject and UploadPart requests. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). If - DisablePayloadSigning is true, UseChunkEncoding will be automatically - set to false. - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - If the request needs to be signed with a different service name - than the client config AuthenticationServiceName, set it here to override - the result of DetermineService in AWS4Signer - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Endpoint of the EC2 Instance Metadata Service - - - - - Internet protocol version to be used for communicating with the EC2 Instance Metadata Service - - - - - Determines the configuration values based on environment variables. If - no values is found for a configuration the value will be set to null. - - - - - Attempts to construct a configuration instance of configuration environment - variables. If an environment variable value isn't found then the individual value - for that environment variable will be null. If unable to obtain a value converter - to convert a configuration string to the appropriate type a InvalidOperationException - is thrown. - - - - - Loads the EC2 Instance Metadata endpoint from the environment variable, and validates it is a well-formed uri - - Override EC2 instance metadata endpoint if valid, else an empty string - - - - Determines configuration values based on a stored in an . - If the profile doesn't exist, the status will be logged and no value will be set in the configuration. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Endpoint of the EC2 Instance Metadata Service - - - - - Internet protocol version to be used for communicating with the EC2 Instance Metadata Service - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - If the request needs to be signed with a different service name - than the client config AuthenticationServiceName, set it here to override - the result of DetermineService in AWS4Signer - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing - data integrity check on this request. - If using SigV4, the DisablePayloadSigning flag controls if the payload should be - signed on a request by request basis. By default this flag is null which will use the - default client behavior. The default client behavior is to sign the payload. When - DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. - Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS - connection. - Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may - be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies - to Amazon S3 PutObject and UploadPart requests. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). If - DisablePayloadSigning is true, UseChunkEncoding will be automatically - set to false. - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Lookup of element names that are not skipped if empty within the XML response structure. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - Constructs a new instance of the HttpWebRequestResponseData class with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream and advances - the position within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Closes the underlying stream and finishes calculating the hash. - If an ExpectedHash is specified and is not equal to the calculated hash, - this method will throw an AmazonClientException. - - - If ExpectedHash is set and is different from CalculateHash that the stream calculates. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Returns the least recently used item if it exists. - - The item that is least recently used or the default value of the LruListItem class if the LRU cache is empty. - - - - Method to evict expired LRUListItems. - - Number of seconds the LRUListItems are valid for. - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Close implementation for this wrapper stream - does not close the underlying stream. - - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Overridden StringWriter that escapes additional characters in XML requests for consistency across AWS SDKs. - There isn't an XmlWriterSettings.NewLineHandling value which matches the desired - encoding, so this replaces the characters that NewLineHandling.Entitize doesn't encode - - - - - Writes a range of a character array to the underlying string buffer and - encodes additional characters for AWS XML requests - - Characters to write to underlying string buffer - Position in buffer to start writing from - Number of characters to write - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Adds a parameter with a list-of-doubles value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Shared logic for the HandleException and HandleExceptionAsync - - - - - - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - The exception handler for HttpErrorResponseException exception. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Constructs a new instance of the HttpErrorResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The request factory for System.Net.HttpWebRequest. - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - This method is used for unit testing purposes. It allows setting of the flag - that indicates protocol setting was attempted. - - The new value - - - - Disposes the HttpWebRequestFactory. - - - - - HTTP request wrapper for System.Net.HttpWebRequest. - - - - - Constructor for HttpRequest. - - The request URI. - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Returns the HTTP response. - - The HTTP response. - - - - Gets a handle to the request content. - - The request content. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Aborts the HTTP request. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Gets a handle to the request content. - - Used to cancel the request on demand - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Disposes the HttpRequest. - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Provides information for Client Context header. - Client Context header needs information like App title, version code, version name, package name etc. - - - - - The title of your app. For example, "My App". - If this property is not null, the value would be used in Client Context header. - - - - - The version for your app. For example, V3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The version code of your app. For example, 3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The name of your app package. For example, com.your_company.your_app. - If this property is not null, the value would be used in Client Context header. - - - - - The operating system of the device. For example, iPhoneOS. - If this property is not null, the value would be used in Client Context header. - - - - - The version of the operating system of the device. For example, 8.1. - If this property is not null, the value would be used in Client Context header. - - - - - The locale of the device. For example, en_US. - If this property is not null, the value would be used in Client Context header. - - - - - The manufacturer of the device. For example, Samsung. - If this property is not null, the value would be used in Client Context header. - - - - - The model of the device. For example, Nexus. - If this property is not null, the value would be used in Client Context header. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - RegionEndpoint and ServiceURL are mutually exclusive properties. - Whichever property is set last will cause the other to automatically - be reset to null. - - - - - - The constant used to lookup in the region hash the endpoint. - - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - RegionEndpoint and ServiceURL are mutually exclusive properties. - Whichever property is set last will cause the other to automatically - be reset to null. - - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - Specifies the TCP keep-alive values to use for service requests. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets the ProxyPort property. - - - - - Gets and sets the ProxyBypassList property; a collection - of regular expressions denoting the set of endpoints for - which the configured proxy host will be bypassed. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - Gets and sets the ProxyBypassOnLocal property. - If set true requests to local addresses bypass the configured - proxy. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - - The proxy details - - - - Gets and sets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets and sets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - The request retry mode as legacy, standard, or adaptive - - - - - Specified how many HTTP requests an SDK should make for a single - SDK operation invocation before giving up. - - - - - Endpoint of the EC2 Instance Metadata Service - - - - - Internet protocol version to be used for communicating with the EC2 Instance Metadata Service - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - The AWS account ID that temporary AWS credentials will be resolved for using AWS SSO. - - - - - The AWS region where the SSO directory for is hosted. - - - - - The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for using AWS SSO. - - - - - The main URL for users to login to their SSO directory. - Provided by the SSO service via the web console. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - The source identity specified by the principal that is calling the AssumeRole - operation. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - If either AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or AWS_CONTAINER_CREDENTIALS_FULL_URI environment variables are set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If either AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or AWS_CONTAINER_CREDENTIALS_FULL_URI environment variables are set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationCancelledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-empty. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - An SSO Token is used by the SSO AWS Credentials provider to request permission to get credentials. - SSO Tokens are persisted using . - - - - - Token string returned by the SSOOIDC service (IAmazonSSOOIDC). - - - - - Expiration time of - - - - - The configured sso_region for the profile that credentials are being resolved for. - - - - - The configured sso_start_url for the profile that credentials are being resolved for. - - - - - Cached Storage IO for SSO Tokens () - - - - - Path to a token cache file. Caching is disabled when this is null. - - - - - Class constructor - Caches SSO Tokens to disk under (user profile)/.aws/sso/cache/ - - The configured sso_start_url for the profile that credentials are being resolved for. - - - - Overload used for unit testing (allows for custom storage location) - - The folder containing Cached SSO Tokens. If this is null, caching is disabled. - The configured sso_start_url for the profile that credentials are being resolved for. - - - - Retrieves the SSO Token's AccessToken. - - - SSO Token AccessToken. - Returns null if the token has expired, or if the cache is invalid or does not exist. - - - - - Caches an SSO Token to disk. - - SSO Token to cache - - - - Loads an SSO Token from cache - - - This method is private. The spec prohibits storing Tokens in memory. They are to be accessed to from disk - when necessary. - - Loaded SSO Token. Returns null if no cache exists, or is otherwise corrupt. - - - - Determines the file name of the Token Cache, regardless of folder. - - The Token's start url - The filename to be used for a Token representing - - - - Produces the default SSO Token Cache Folder path [(user profile)/.aws/sso/cache/], - returning null if this cannot be determined. - - Default path, null if unable to be determined - - - - Generate a SHA1 hash for the given text - - Text to generate a hash for - SHA1 hash for - - - - Whether or not the SSO Token is considered expired - - SSO Token to check if expired - false if the token is not expired, true otherwise - - - - Serializes the SSO Token to JSON - - Token to serialize - - - - Serializes the SSO Token to JSON - - Token to serialize - - - - Deserializes the SSO Token from JSON - - JSON (string) to deserialize - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - AWS Credentials that resolve using AWS SSO. - - - - - The AWS account ID that temporary AWS credentials will be resolved for. - - - - - The AWS region where the SSO directory for is hosted. - - - - - The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for. - - - - - The main URL for users to login to their SSO directory. - Provided by the SSO service via the web console. - - - - - Options to be used in the SSO flow to resolve credentials. - Developers wishing to support AWS SSO would want to provide the following: - - - - - - - - - Constructs an SSOAWSCredentials object. - - The AWS account ID that temporary AWS credentials will be resolved for. - The AWS region where the SSO directory for is hosted. - The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for. - The main URL for users to login to their SSO directory. - - - - Constructs an SSOAWSCredentials object. - - The AWS account ID that temporary AWS credentials will be resolved for. - The AWS region where the SSO directory for is hosted. - The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for. - The main URL for users to login to their SSO directory. - Options to be used in the SSO flow to resolve credentials. - - - - Attempts to get a service client at runtime which cannot be made a project reference. - - - - - Performs the SSO flow to authenticate and get credentials - - SSO OIDC client - SSO client - Resolved credentials - - - - Performs the SSO flow to authenticate and get credentials - - SSO OIDC client - SSO client - Resolved credentials - - - - Produces a client name watermarked with a timestamp for use in this provider's SSO Flow. - - - "sometool" -> "sometool-1599153467" - - A Client Name to use in the internal SSO flow - - - - Get resolved credentials from an AWS SSO access token - - AWS SSO Client - AWS SSO access token obtained from a user's authorization - Resolved credentials - - - - Get resolved credentials from an AWS SSO access token - - AWS SSO Client - AWS SSO access token obtained from a user's authorization - Resolved credentials - - - - The end-user verification code that is provided (by the user or on their behalf) when - the user logs in using - - - - - End-user verification URI on the authorization server. - - - - - A verification URI that includes the "user_code", designed for non-textual transmission. - - - - - Produces a stock message that can be presented to users, instructing them how to log in through SSO. - - - - - Required - Name of the application or system used during SSO client registration. - A timestamp indicating when the client was registered will be appended to requests made to the SSOOIDC service. - - - - - A callback that is used to initiate the SSO Login flow with the user. - - - - - The proxy settings to use when calling SSOOIDC and SSO Services. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating through AWS SSO. - - - - - The expiry time of the credentials, obtained from the AWS SSO service. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this SSOImmutableCredentials object. - - A copy of this object. - - - - Obtains credentials from access key/secret key or AWSProfileName settings - in the application's app.config or web.config file. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the CredentialRequestCallbackRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Credentials that are retrieved from ConfigurationManager.AppSettings - - - - - Constructs an instance of EnvironmentAWSCredentials and attempts - to load AccessKey and SecretKey from ConfigurationManager.AppSettings - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - 1. Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. The ini-format files used by the AWS CLI - and some other SDKs are not supported at this time. -
- 2. In order to use the StoredProfileFederatedCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Custom state to return to the registered callback to handle credential requests. - The data will be contained in the CredentialRequestCallbackArgs instance supplied - to the callback. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - Callback signature for obtaining user credentials that may be needed for authentication. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Constructs an instance of StoredProfileFederatedCredentials using the profile name specified - in the App.config. If no profile name is specified then the default credentials are used. - - - - - Constructs an instance of StoredProfileFederatedCredentials. Credentials will be searched - for using the profileName parameter. - - The profile name to search for credentials for - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - Null or proxy settings to be used during the HHTPS authentication calls when generating credentials. - /// - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - Registers a callback handler for scenarios where credentials need to be supplied - during user authentication (primarily the non-domain-joined use case). Custom data, - which will be supplied in the CredentialRequestCallbackArgs instance passed to the - callback, can also be supplied. - - - The callback will only be invoked if the underlying SAML role profile indicates it - was set up for use with a specific identity. For profiles that do not contain any user - identity the SDK will default to using the identity of the current process during - authentication. Additionally, if the profile contain user identity information but no - callback has been registered, the SDK will also attempt to use the current process - identity during authentication. - - - The handler to be called - - Custom state data to be supplied in the arguments to the callback. - - - Only one callback handler can be registered. The call to the handler will be made on - whatever thread is executing at the time a demand to provide AWS credentials is made. - If the handler code requires that UI need to be displayed, the handler should - transition to the UI thread as appropriate. - - - - - Tests if an instance can be created from the persisted profile data. - - The name of the profile to test. - The location of the shared ini-format credential file. - True if the persisted data would yield a valid credentials instance. - - This profile type is currently only supported in the SDK credential store file. - The shared ini-format file is not currently supported; any value supplied - for the profilesLocation value is ignored. - - - - - Performs any additional validation we may require on the profile content. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - EC2MetadataServiceEndpointMode determines the internet protocol version - to be used for communicating with the EC2 Instance Metadata Service - - - - - Internet Protocol version 4 - - - - - Internet Protocol version 6 - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Constructs a new instance of the EventStreamErrorCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Constructs a new instance of the EventStreamParseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Constructs a new instance of the EventStreamChecksumFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Constructs a new instance of the EventStreamDecoderIllegalStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Constructs a new instance of the UnknownEventStreamMessageTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - Constructs a new instance of the UnknownEventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Gets the TCP keep-alive values to use for service requests. Enabling TCP keep-alive sends periodic TCP keep-alive probe packets, to prevent disconnection due to - network inactivity. This is useful when you make API calls that take a long time to respond. In this case, the connection could be dropped by an intermediate - node (e.g. proxy) as the connection is inactive for a long time. Timeout controls the duration of inactivity before a keep-alive probe packet is sent. - Interval controls the amount of time to wait before retrying a keep-alive probe packet in the event the server doesn't respond to a keep-alive probe. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Gets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets the default read-write timeout value. - - - - - - - Gets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Double list parameter value. - - - - - List of doubles value of the parameter. - - - - - Constructs ParameterValue for a list of doubles. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Delete the object. - - - - - - - - Deletes the ojects. - - - - - - - - Upload an object from a stream. - - - - - - - - - Upload an object from a file path. - - - - - - - - - Download object to a file path. - - - - - - - - - Get stream for an object. - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Get the attributes for the queue identified by the queue URL. - - The queue URL to get attributes for. - The attributes for the queue. - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Set the attributes on the queue identified by the queue URL. - - The queue URL to set the attributues. - The attributes to set. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - ICoreAmazonSSO is not meant to be used directly. It defines SSO - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSSOClient - defined in the AWSSDK.SSO assembly. - - - - - ICoreAmazonSSOOIDC is not meant to be used directly. It defines SSO OIDC - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSSOOIDCClient - defined in the AWSSDK.SSOOIDC assembly. - - - - - This method is used internally to access the Amazon SSO OIDC service within other service assemblies. - Please use AmazonSSOOIDCClient to access the Amazon SSO OIDC service instead. - - Use Amazon SSO OIDC to get an SSO Token - - - - - This method is used internally to access the Amazon SSO OIDC service within other service assemblies. - Please use AmazonSSOOIDCClient to access the Amazon SSO OIDC service instead. - - Use Amazon SSO OIDC to get an SSO Token - - - - - Name of the application or system used during SSO client registration. - - - - - OAuth client type - - - - - The StartUrl to request an SSO Token from. - - - - - Callback for presenting the user with a SSO Login flow. - - - - - Additional properties to provide to the operation. - Optional, can be null. - - - - - The SSO login token that can be exchanged for temporary AWS credentials. - - - - - When expires - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Interface for enumerables consumed by the customer - to read responses or result keys - - - - - - Interface for operation paginators - - - - - - An enumerable containing all of the responses for a paginated - operation - - - - - - Create a PaginatedResponse object by providing - any operation paginator - - - - - - Get responses synchronously - - - - - - An enumerable containing all of the Result Keys for a paginator - - - - - - - Create a PaginatedResultKeyResponse by providing any operation paginator - and a selector function for the result key - - - - - - - Get the result keys synchronously - - - - - - TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives. - - - - - Specifies if TCP keep-alive is enabled or disabled. The default value is false for all services except Lambda. - - - - - The timeout before a TCP keep-alive packet will be sent. The timeout value must be greater - than 0 seconds and not null if Enabled is set to true. The default value is 5 minutes. - - - - - The interval before retrying a TCP keep-alive packet that did not receive an acknowledgement. The - interval must be greater than 0 seconds and not null if Enabled is set to true. The default value is 15 seconds. - - - - - Root AWS config section - - - - - Gets and sets the proxy settings for the SDK to use. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - Gets and sets the host name or IP address of the proxy server. - - - - - Gets and sets the port number of the proxy. - - - - - Gets and sets the username to authenticate with the proxy server. - - - - - Gets and sets the password to authenticate with the proxy server. - - - - - Gets and set the proxy bypass list. A set of semi-colon - delimited regular expressions denoting the addresses that - should bypass the proxy. - - - - - Gets and sets the proxy option to bypass local addresses. - - - - - Logging section - - - - - Easy-to-use generic collection - - - - - - Configuration element that serializes properly when used with collections - - - - - ConfigurationElement class which returns false for IsReadOnly - - - - - Settings for configuring a proxy for the SDK to use. - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - Settings for configuring CSM in the SDK. - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Utility method for converting Unix epoch milliseconds to DateTime structure. - - The number of milliseconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Generates an MD5 Digest for the stream specified - - The Stream for which the MD5 Digest needs - to be computed. - A string representation of the hash with base64 encoding - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - Base endpoint of the instance metadata service. Returns the endpoint configured first - via environment variable AWS_EC2_METADATA_SERVICE_ENDPOINT then the current profile's - ec2_metadata_service_endpoint value. If a specific endpoint is not configured, it selects a pre-determined - endpoint based on environment variable AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE then the - current profile's ec2_metadata_service_endpoint_mode setting. - - - - - Root URI to retrieve instance metadata - - - - - Root URI to retrieve instance user data - - - - - Root URI to retrieve dynamic instance data - - - - - URI to retrieve the IMDS API token - - - - - Returns whether requesting the EC2 Instance Metadata Service is - enabled via the AWS_EC2_METADATA_DISABLED environment variable. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Finds region string in the endpoint string using predefined rules - If predefined rules fail to match the region, regular expression strings provided in - endpoints.json are used to find the region. - If regular expressions also fail, then a default region is returned. - - - - - Finds the region in the provided endpoint parsing from right to left - Try to find exact match of the region in endpoints.json - If there doesn't exist an exact match, find a fuzzy match - Else return default region - - Endpoint string - First successfully parsed region from right to left in the given endpoint or default region - - - - Returns the Domain Name System host name - - URL string - A String containing the authority component of the URL - - - - Find region in the endpoint using endpoints.json region regexs - If there doesn't exist a match, return null - - - First matched region from right to left in the given endpoint or null - - - - Find endpoint segment in the endpoint parsing right to left - If there exists an exception such as us-gov, return exception value - Else return null - - Endpoint string - First parsed region from right to left in the given endpoint or null - - - - Builds an exception tree root that is used to handle the exception cases for an endpoint to determine the region. - New exceptions must be added as a child to the root. - If there exists a sub-exception that depends on the parent exception, it must be added as a child to the parent node - For example, us-gov followed by s-accelerate from right to left, then us-gov must have s3-accelerate as a Child - - Root of exception tree - - - - Gets the singleton. - - - - - Root AWS config - - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - The unique application name for the current application. This values is currently used - by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file - path to store local database files. - Changes to this setting will only take effect in newly-constructed objects using this property. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws applicationName="" /> - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Generates a sample XML representation of the SDK configuration section. - - - The XML returned has an example of every tag in the SDK configuration - section, and sample input for each attribute. This can be included in - an App.config or Web.config and edited to suit. Where a section contains - a collection, multiple of the same tag will be output. - - Sample XML configuration string. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. Map is keyed by region SystemName. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Force the SDK to load and apply the given endpoints details - (eg: an updated endpoints.json file). - Service clients created after this call will be set up with - endpoints based on this information. - - This function should only be used at application startup, before - creating service clients. - - Known Caveats: - * static readonly fields (eg: ) are not updated. - If you use this function, you should use with - explicit region system names to ensure you work with RegionEndpoint objects containing - the reloaded data. RegionEndpoint objects returned from GetEndpoint will generally - fail Equality comparisons against the static fields. - * Service clients created before calling Reload have no guarantee around - which endpoint data will be used. - - Stream containing an Endpoints manifest to reload in the SDK. - Pass null in to reset the SDK, so that it uses its built-in manifest instead. - - - - Rebuilds the endpoint override map, referencing the SDK's current Region Endpoint data. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - The US East (Virginia) regional endpoint. - S3-specific, use for backward compatibility only. - - - - - The Africa (Cape Town) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Europe (Frankfurt) endpoint. - - - - - The Europe (Stockholm) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Europe (Ireland) endpoint. - - - - - The Europe (London) endpoint. - - - - - The Europe (Paris) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US East (N. Virginia) endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The AWS GovCloud (US-East) endpoint. - - - - - The AWS GovCloud (US-West) endpoint. - - - - - The US ISO East endpoint. - - - - - The US ISOB East (Ohio) endpoint. - - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.dll.meta deleted file mode 100644 index 95bb3a88..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 7df20c511863dd44aadbd060e356e2c1 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 1 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml deleted file mode 100644 index c73e431f..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.GameLift.xml +++ /dev/null @@ -1,54227 +0,0 @@ - - - - AWSSDK.GameLift - - - - - AWS access credentials required to upload game build files to GameLift. These credentials - are generated with CreateBuild, and are valid for a limited time. If they expire - before you upload your game build, get a new set by calling RequestUploadCredentials. - - - Temporary access credentials used for uploading game build files to Amazon GameLift. - They are valid for a limited time. If they expire before you upload your game build, - get a new set by calling RequestUploadCredentials. - - - - - Returns a copy of ImmutableCredentials corresponding to these credentials - - - - - - Gets and sets the property AccessKeyId. - - Temporary key allowing access to the Amazon GameLift S3 account. - - - - - - Gets and sets the property SecretAccessKey. - - Temporary secret key allowing access to the Amazon GameLift S3 account. - - - - - - Gets and sets the property SessionToken. - - Token used to associate a specific build ID with the files uploaded using these credentials. - - - - - - Container for the parameters to the AcceptMatch operation. - Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking - configuration may require player acceptance; if so, then matches built with that configuration - cannot be completed unless all players accept the proposed match within a specified - time limit. - - - - When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - your game to get acceptance from all players in the ticket. Acceptances are only valid - for tickets when they are in this status; all other acceptances result in an error. - - - - To register acceptance, specify the ticket ID, a response, and one or more players. - Once all players have registered acceptance, the matchmaking tickets advance to status - PLACING, where a new game session is created for the match. - - - - If any player rejects the match, or if acceptances are not received before a specified - timeout, the proposed match is dropped. The matchmaking tickets are then handled in - one of two ways: For tickets where one or more players rejected the match, the ticket - status is returned to SEARCHING to find a new match. For tickets where - one or more players failed to respond, the ticket status is set to CANCELLED, - and processing is terminated. A new matchmaking request for these players can be submitted - as needed. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - FlexMatch events (reference) - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - - - - Gets and sets the property AcceptanceType. - - Player response to the proposed match. - - - - - - Gets and sets the property PlayerIds. - - A unique identifier for a player delivering the response. This parameter can include - one or multiple player IDs. - - - - - - Gets and sets the property TicketId. - - A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; - otherwise this request will fail. - - - - - - This is the response object from the AcceptMatch operation. - - - - - Properties that describe an alias resource. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property AliasArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - In a GameLift alias ARN, the resource ID matches the alias ID value. - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias. Alias IDs are unique within a Region. - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Description. - - A human-readable description of an alias. - - - - - - Gets and sets the property LastUpdatedTime. - - The time that this data object was last modified. Format is a number expressed in - Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with an alias. Alias names do not need to be - unique. - - - - - - Gets and sets the property RoutingStrategy. - - The routing configuration, including routing type and fleet target, for the alias. - - - - - - - Values for use in Player attribute key-value pairs. This object lets you specify - an attribute value using any of the valid data types: string, number, string array, - or data map. Each AttributeValue object can use only one of the available - properties. - - - - - Gets and sets the property N. - - For number values, expressed as double. - - - - - - Gets and sets the property S. - - For single string values. Maximum string length is 100 characters. - - - - - - Gets and sets the property SDM. - - For a map of up to 10 data type:value pairs. Maximum length for each string value - is 100 characters. - - - - - - Gets and sets the property SL. - - For a list of up to 10 strings. Maximum length for each string is 100 characters. - Duplicate values are not recognized; all occurrences of the repeated value after the - first of a repeated value are ignored. - - - - - - Properties describing a custom game build. - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property BuildArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift build resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - In a GameLift build ARN, the resource ID matches the BuildId value. - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build. - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a build. Build names do not need to be - unique. It can be set using CreateBuild or UpdateBuild. - - - - - - Gets and sets the property OperatingSystem. - - Operating system that the game server binaries are built to run on. This value determines - the type of fleet resources that you can use for this build. - - - - - - Gets and sets the property SizeOnDisk. - - File size of the uploaded game build, expressed in bytes. When the build status is - INITIALIZED, this value is 0. - - - - - - Gets and sets the property Status. - - Current status of the build. - - - - Possible build statuses include the following: - -
  • - - INITIALIZED -- A new build has been defined, but no files have been uploaded. - You cannot create fleets for builds that are in this status. When a build is successfully - created, the build status is set to this value. - -
  • - - READY -- The game build has been successfully uploaded. You can now create - new fleets for this build. - -
  • - - FAILED -- The game build upload failed. You cannot create new fleets for this - build. - -
- - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. This value can be set using CreateBuild or UpdateBuild. - - - - - - Determines whether a TLS/SSL certificate is generated for a fleet. This feature must - be enabled when creating the fleet. All instances in a fleet share the same certificate. - The certificate can be retrieved by calling the GameLift - Server SDK operation GetInstanceCertificate. - - - - A fleet's certificate configuration is part of FleetAttributes. - - - - - - Gets and sets the property CertificateType. - - Indicates whether a TLS/SSL certificate is generated for a fleet. - - - - Valid values include: - -
  • - - GENERATED - Generate a TLS/SSL certificate for this fleet. - -
  • - - DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet. - - -
- - - - - - - - Container for the parameters to the ClaimGameServer operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Locates an available game server and temporarily reserves it to host gameplay and - players. This operation is called from a game client or client service (such as a - matchmaker) to request hosting resources for a new game session. In response, GameLift - FleetIQ locates an available game server, places it in CLAIMED status - for 60 seconds, and returns connection information that players can use to connect - to the game server. - - - - To claim a game server, identify a game server group. You can also specify a game - server ID, although this approach bypasses GameLift FleetIQ placement optimization. - Optionally, include game data to pass to the game server at the start of a game session, - such as a game map or player information. - - - - When a game server is successfully claimed, connection information is returned. A - claimed game server's utilization status remains AVAILABLE while the - claim status is set to CLAIMED for up to 60 seconds. This time period - gives the game server time to update its status to UTILIZED (using UpdateGameServer) - once players join. If the game server's status is not updated within 60 seconds, the - game server reverts to unclaimed status and is available to be claimed by another - request. The claim time period is a fixed value and is not configurable. - - - - If you try to claim a specific game server, this request will fail in the following - cases: - -
  • - - If the game server utilization status is UTILIZED. - -
  • - - If the game server claim status is CLAIMED. - -
- - When claiming a specific game server, this request will succeed even if the game server - is running on an instance in DRAINING status. To avoid this, first check - the instance status by calling DescribeGameServerInstances. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property GameServerData. - - A set of custom game server properties, formatted as a single string value. This data - is passed to a game client or service when it requests information on game servers - using ListGameServers or ClaimGameServer. - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. If you are not specifying a game - server to claim, this value identifies where you want GameLift FleetIQ to look for - an available game server to claim. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server to claim. If this parameter - is left empty, GameLift FleetIQ searches for an available game server in the specified - game server group. - - - - - - This is the response object from the ClaimGameServer operation. - - - - - Gets and sets the property GameServer. - - Object that describes the newly claimed game server. - - - - - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - - - Constructs a new ConflictException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ConflictException - - - - - - - Construct instance of ConflictException - - - - - - Construct instance of ConflictException - - - - - - - - - - - Construct instance of ConflictException - - - - - - - - - - Constructs a new instance of the ConflictException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the CreateAlias operation. - Creates an alias for a fleet. In most situations, you can use an alias ID in place - of a fleet ID. An alias provides a level of abstraction for a fleet that is useful - when redirecting player traffic from one fleet to another, such as when updating your - game build. - - - - Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. - A simple alias points to an active fleet. A terminal alias is used to display messaging - or link to a URL instead of routing players to an active fleet. For example, you might - use a terminal alias when a game version is no longer supported and you want to direct - players to an upgrade site. - - - - To create a fleet alias, specify an alias name, routing strategy, and optional description. - Each simple alias can point to only one fleet, but a fleet can have multiple aliases. - If successful, a new alias record is returned, including an alias ID and an ARN. You - can reassign an alias to another fleet by calling UpdateAlias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property Description. - - A human-readable description of the alias. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with an alias. Alias names do not need to be - unique. - - - - - - Gets and sets the property RoutingStrategy. - - The routing configuration, including routing type and fleet target, for the alias. - - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new alias resource. Tags are developer-defined key-value - pairs. Tagging AWS resources are useful for resource management, access management - and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Alias. - - The newly created alias resource. - - - - - - Container for the parameters to the CreateBuild operation. - Creates a new Amazon GameLift build resource for your game server binary files. Game - server binaries must be combined into a zip file for use with Amazon GameLift. - - - - When setting up a new game build for GameLift, we recommend using the AWS CLI command - upload-build - . This helper command combines two tasks: (1) it uploads your build files from - a file directory to a GameLift Amazon S3 location, and (2) it creates a new build - resource. - - - - The CreateBuild operation can used in the following scenarios: - -
  • - - To create a new game build with build files that are in an Amazon S3 location under - an AWS account that you control. To use this option, you must first give Amazon GameLift - access to the Amazon S3 bucket. With permissions in place, call CreateBuild - and specify a build name, operating system, and the Amazon S3 storage location of - your game build. - -
  • - - To directly upload your build files to a GameLift Amazon S3 location. To use this - option, first call CreateBuild and specify a build name and operating - system. This operation creates a new build resource and also returns an Amazon S3 - location with temporary access credentials. Use the credentials to manually upload - your build files to the specified Amazon S3 location. For more information, see Uploading - Objects in the Amazon S3 Developer Guide. Build files can be uploaded to - the GameLift Amazon S3 location once only; that can't be updated. - -
- - If successful, this operation creates a new build resource with a unique build ID - and places it in INITIALIZED status. A build must be in READY - status before you can create fleets with it. - - - - Learn more - - - - Uploading - Your Game - - - - - Create a Build with Files in Amazon S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a build. Build names do not need to be - unique. You can use UpdateBuild to change this value later. - - - - - - Gets and sets the property OperatingSystem. - - The operating system that the game server binaries are built to run on. This value - determines the type of fleet resources that you can use for this build. If your game - build contains multiple executables, they all must run on the same operating system. - If an operating system is not specified when creating a build, Amazon GameLift uses - the default value (WINDOWS_2012). This value cannot be changed later. - - - - - - Gets and sets the property StorageLocation. - - Information indicating where your game build files are stored. Use this parameter - only when creating a build with files stored in an Amazon S3 bucket that you own. - The storage location must specify an Amazon S3 bucket name and key. The location must - also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon - S3 bucket. The S3 bucket and your new build must be in the same Region. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new build resource. Tags are developer-defined key-value - pairs. Tagging AWS resources are useful for resource management, access management - and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. You can use UpdateBuild to change this value later. - - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Build. - - The newly created build resource, including a unique build IDs and status. - - - - - - Gets and sets the property StorageLocation. - - Amazon S3 location for your game build file, including bucket name and key. - - - - - - Gets and sets the property UploadCredentials. - - This element is returned only when the operation is called without a storage location. - It contains credentials to use when you are uploading a build file to an Amazon S3 - bucket that is owned by Amazon GameLift. Credentials have a limited life span. To - refresh these credentials, call RequestUploadCredentials. - - - - - - Container for the parameters to the CreateFleetLocations operation. - Adds remote locations to a fleet and begins populating the new locations with EC2 - instances. The new instances conform to the fleet's instance type, auto-scaling, and - other configuration settings. - - - - This operation cannot be used with fleets that don't support remote locations. Fleets - can have multiple locations only if they reside in AWS Regions that support this feature - (see CreateFleet for the complete list) and were created after the feature - was released in March 2021. - - - - To add fleet locations, specify the fleet to be updated and provide a list of one - or more locations. - - - - If successful, this operation returns the list of added locations with their status - set to NEW. GameLift initiates the process of starting an instance in - each added location. You can track the status of each new location by monitoring location - creation events using DescribeFleetEvents. Alternatively, you can poll location - status by calling DescribeFleetLocationAttributes. After a location status - becomes ACTIVE, you can adjust the location's capacity as needed with - UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to add locations to. You can use either the fleet - ID or ARN value. - - - - - - Gets and sets the property Locations. - - A list of locations to deploy additional instances to and manage as part of the fleet. - You can add any GameLift-supported AWS Region as a remote location, in the form of - an AWS Region code such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that was updated with new locations. - - - - - - Gets and sets the property LocationStates. - - The remote locations that are being added to the fleet, and the life-cycle status - of each location. For new locations, the status is set to NEW. During - location creation, GameLift updates each location's status as instances are deployed - there and prepared for game hosting. This list does not include the fleet home Region - or any remote locations that were already added to the fleet. - - - - - - Container for the parameters to the CreateFleet operation. - Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your - custom game server or Realtime Servers. Use this operation to configure the computing - resources for your fleet and provide instructions for running game servers on each - instance. - - - - Most GameLift fleets can deploy instances to multiple locations, including the home - Region (where the fleet is created) and an optional set of remote locations. Fleets - that are created in the following AWS Regions support multiple locations: us-east-1 - (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets - that are created in other GameLift Regions can deploy instances in the fleet's home - Region only. All fleet instances use the same configuration regardless of location; - however, you can adjust capacity settings and turn auto-scaling on/off for each location. - - - - To create a fleet, choose the hardware for your instances, specify a game server build - or Realtime script to deploy, and provide a runtime configuration to direct GameLift - how to start and run game servers on each instance in the fleet. Set permissions for - inbound traffic to your game servers, and enable optional features as needed. When - creating a multi-location fleet, provide a list of additional remote locations. - - - - If successful, this operation creates a new Fleet resource and places it in NEW - status, which prompts GameLift to initiate the fleet - creation workflow. You can track fleet creation by checking fleet status using - DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by - monitoring fleet creation events using DescribeFleetEvents. As soon as the - fleet status changes to ACTIVE, you can enable automatic scaling for - the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. - When the status of each remote location reaches ACTIVE, you can set capacity - by location using UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Debug - fleet creation issues - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - - - - Gets and sets the property BuildId. - - The unique identifier for a custom game server build to be deployed on fleet instances. - You can use either the build ID or ARN. The build must be uploaded to GameLift and - in READY status. This fleet property cannot be changed later. - - - - - - Gets and sets the property CertificateConfiguration. - - Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates - are used for encrypting traffic between game clients and the game servers that are - running on GameLift. By default, the CertificateConfiguration is set - to DISABLED. Learn more at Securing - Client/Server Communication. This property cannot be changed after the fleet is - created. - - - - Note: This feature requires the AWS Certificate Manager (ACM) service, which is not - available in all AWS regions. When working in a region that does not support this - feature, a fleet creation request with certificate generation fails with a 4xx error. - - - - - - Gets and sets the property Description. - - A human-readable description of the fleet. - - - - - - Gets and sets the property EC2InboundPermissions. - - The allowed IP address ranges and port settings that allow inbound traffic to access - game sessions on this fleet. If the fleet is hosting a custom game build, this property - must be set before players can connect to game sessions. For Realtime Servers fleets, - GameLift automatically sets TCP and UDP ranges. - - - - - - Gets and sets the property EC2InstanceType. - - The GameLift-supported EC2 instance type to use for all fleet instances. Instance - type determines the computing resources that will be used to host your game servers, - including CPU, memory, storage, and networking capacity. See Amazon - EC2 Instance Types for detailed descriptions of EC2 instance types. - - - - - - Gets and sets the property FleetType. - - Indicates whether to use On-Demand or Spot instances for this fleet. By default, this - property is set to ON_DEMAND. Learn more about when to use - On-Demand versus Spot Instances. This property cannot be changed after the fleet - is created. - - - - - - Gets and sets the property InstanceRoleArn. - - A unique identifier for an AWS IAM role that manages access to your AWS services. - With an instance role ARN set, any application that runs on an instance in this fleet - can assume the role, including install scripts, server processes, and daemons (background - processes). Create a role or look up a role's ARN by using the IAM - dashboard in the AWS Management Console. Learn more about using on-box credentials - for your game servers at - Access external resources from a game server. This property cannot be changed - after the fleet is created. - - - - - - Gets and sets the property Locations. - - A set of remote locations to deploy additional instances to and manage as part of - the fleet. This parameter can only be used when creating fleets in AWS Regions that - support multiple locations. You can add any GameLift-supported AWS Region as a remote - location, in the form of an AWS Region code such as us-west-2. To create - a fleet with instances in the home Region only, omit this parameter. - - - - - - Gets and sets the property LogPaths. - - This parameter is no longer used. To specify where GameLift should store log - files once a server process shuts down, use the GameLift server API ProcessReady() - and specify one or more directory paths in logParameters. See more information - in the Server - API Reference. - - - - - - Gets and sets the property MetricGroups. - - The name of an AWS CloudWatch metric group to add this fleet to. A metric group is - used to aggregate the metrics for multiple fleets. You can specify an existing metric - group name or set a new name to create a new metric group. A fleet can be included - in only one metric group at a time. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet. Fleet names do not need to be - unique. - - - - - - Gets and sets the property NewGameSessionProtectionPolicy. - - The status of termination protection for active game sessions on the fleet. By default, - this property is set to NoProtection. You can also set game session protection - for an individual game session by calling UpdateGameSession. - -
  • - - NoProtection - Game sessions can be terminated during active gameplay as a - result of a scale-down event. - -
  • - - FullProtection - Game sessions in ACTIVE status cannot be terminated - during a scale-down event. - -
- - - - - Gets and sets the property PeerVpcAwsAccountId. - - Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS - account that owns the VPC. You can find your account ID in the AWS Management Console - under account settings. - - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - Gets and sets the property ResourceCreationLimitPolicy. - - A policy that limits the number of game sessions that an individual player can create - on instances in this fleet within a specified span of time. - - - - - - Gets and sets the property RuntimeConfiguration. - - Instructions for how to launch and maintain server processes on instances in the fleet. - The runtime configuration defines one or more server process configurations, each - identifying a build executable or Realtime script file and the number of processes - of that type to run concurrently. - - - - The RuntimeConfiguration parameter is required unless the fleet is being - configured using the older parameters ServerLaunchPath and ServerLaunchParameters, - which are still supported for backward compatibility. - - - - - - - Gets and sets the property ScriptId. - - The unique identifier for a Realtime configuration script to be deployed on fleet - instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift - prior to creating the fleet. This fleet property cannot be changed later. - - - - - - Gets and sets the property ServerLaunchParameters. - - This parameter is no longer used. Specify server launch parameters using the - RuntimeConfiguration parameter. Requests that use this parameter instead - continue to be valid. - - - - - - Gets and sets the property ServerLaunchPath. - - This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration - parameter. Requests that use this parameter instead continue to be valid. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new fleet resource. Tags are developer-defined key-value - pairs. Tagging AWS resources are useful for resource management, access management - and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the fleet is created, - you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetAttributes. - - The properties for the new fleet, including the current status. All fleets are placed - in NEW status on creation. - - - - - - Gets and sets the property LocationStates. - - The fleet's locations and life-cycle status of each location. For new fleets, the - status of all locations is set to NEW. During fleet creation, GameLift - updates each location status as instances are deployed there and prepared for game - hosting. This list includes an entry for the fleet's home Region. For fleets with - no remote locations, only one entry, representing the home Region, is returned. - - - - - - Container for the parameters to the CreateGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a GameLift FleetIQ game server group for managing game hosting on a collection - of Amazon EC2 instances for game hosting. This operation creates the game server group, - creates an Auto Scaling group in your AWS account, and establishes a link between - the two groups. You can view the status of your game server groups in the GameLift - console. Game server group metrics and events are emitted to Amazon CloudWatch. - - - - Before creating a new game server group, you must have the following: - -
  • - - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with - your game server build. For more information, see - Launching an Instance from a Launch Template in the Amazon EC2 User Guide. - - -
  • - - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ - to create and interact with the Auto Scaling group. For more information, see Create - IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. - -
- - To create a new game server group, specify a unique group name, IAM role and Amazon - EC2 launch template, and provide a list of instance types that can be used in the - group. You must also set initial maximum and minimum limits on the group's instance - count. You can optionally set an Auto Scaling policy with target tracking based on - a GameLift FleetIQ metric. - - - - Once the game server group and corresponding Auto Scaling group are created, you have - full access to change the Auto Scaling group's configuration as needed. Several properties - that are set when creating a game server group, including maximum/minimum size and - auto-scaling policy settings, must be updated directly in the Auto Scaling group. - Keep in mind that some Auto Scaling group properties are periodically updated by GameLift - FleetIQ as part of its balancing activities to optimize for availability and cost. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property AutoScalingPolicy. - - Configuration settings to define a scaling policy for the Auto Scaling group that - is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" - to maintain a buffer of idle game servers that can immediately accommodate new games - and players. After the Auto Scaling group is created, update this value directly in - the Auto Scaling group using the AWS console or APIs. - - - - - - Gets and sets the property BalancingStrategy. - - Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances - in the game server group. Method options include the following: - -
  • - - SPOT_ONLY - Only Spot Instances are used in the game server group. If - Spot Instances are unavailable or not viable for game hosting, the game server group - provides no hosting capacity until Spot Instances can again be used. Until then, no - new instances are started, and the existing nonviable Spot Instances are terminated - (after current gameplay ends) and are not replaced. - -
  • - - SPOT_PREFERRED - (default value) Spot Instances are used whenever available - in the game server group. If Spot Instances are unavailable, the game server group - continues to provide hosting capacity by falling back to On-Demand Instances. Existing - nonviable Spot Instances are terminated (after current gameplay ends) and are replaced - with new On-Demand Instances. - -
  • - - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server - group. No Spot Instances are used, even when available, while this balancing strategy - is in force. - -
- - - - - Gets and sets the property GameServerGroupName. - - An identifier for the new game server group. This value is used to generate unique - ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server - group. The name must be unique per Region per AWS account. - - - - - - Gets and sets the property GameServerProtectionPolicy. - - A flag that indicates whether instances in the game server group are protected from - early termination. Unprotected instances that have active game servers running might - be terminated during a scale-down event, causing players to be dropped from the game. - Protected instances cannot be terminated while there are active game servers running - except in the event of a forced game server group deletion (see ). An exception to - this is with Spot Instances, which can be terminated by AWS regardless of protection - status. This property is set to NO_PROTECTION by default. - - - - - - Gets and sets the property InstanceDefinitions. - - The EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions - must specify at least two different instance types that are supported by GameLift - FleetIQ. For more information on instance types, see EC2 - Instance Types in the Amazon EC2 User Guide. You can optionally specify - capacity weighting for each instance type. If no weight value is specified for an - instance type, it is set to the default value "1". For more information about capacity - weighting, see - Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling - User Guide. - - - - - - Gets and sets the property LaunchTemplate. - - The EC2 launch template that contains configuration settings and game server code - to be deployed to all instances in the game server group. You can specify the template - using either the template name or ID. For help with creating a launch template, see - Creating - a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling - User Guide. After the Auto Scaling group is created, update this value directly - in the Auto Scaling group using the AWS console or APIs. - - - - If you specify network interfaces in your launch template, you must explicitly set - the property AssociatePublicIpAddress to "true". If no network interface - is specified in the launch template, GameLift FleetIQ uses your account's default - VPC. - - - - - - - Gets and sets the property MaxSize. - - The maximum number of instances allowed in the EC2 Auto Scaling group. During automatic - scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. - After the Auto Scaling group is created, update this value directly in the Auto Scaling - group using the AWS console or APIs. - - - - - - Gets and sets the property MinSize. - - The minimum number of instances allowed in the EC2 Auto Scaling group. During automatic - scaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. - In production, this value should be set to at least 1. After the Auto Scaling group - is created, update this value directly in the Auto Scaling group using the AWS console - or APIs. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) - for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new game server group resource. Tags are developer-defined - key-value pairs. Tagging AWS resources is useful for resource management, access management, - and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags, respectively. The maximum tag limit may be lower than - stated. See the AWS General Reference for actual tagging limits. - - - - - - Gets and sets the property VpcSubnets. - - A list of virtual private cloud (VPC) subnets to use with instances in the game server - group. By default, all GameLift FleetIQ-supported Availability Zones are used. You - can use this parameter to specify VPCs that you've set up. This property cannot be - updated after the game server group is created, and the corresponding Auto Scaling - group will always use the property value that is set with this request, even if the - Auto Scaling group is updated directly. - - - - - - This is the response object from the CreateGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - The newly created game server group object, including the new ARN value for the GameLift - FleetIQ game server group and the object's status. The EC2 Auto Scaling group ARN - is initially null, since the group has not yet been created. This value is added once - the game server group status reaches ACTIVE. - - - - - - Container for the parameters to the CreateGameSessionQueue operation. - Creates a placement queue that processes requests for new game sessions. A queue uses - FleetIQ algorithms to determine the best placement locations and find an available - game server there, then prompts the game server process to start a new game session. - - - - - A game session queue is configured with a set of destinations (GameLift fleets or - aliases), which determine the locations where the queue can place new game sessions. - These destinations can span multiple fleet types (Spot and On-Demand), instance types, - and AWS Regions. If the queue includes multi-location fleets, the queue is able to - place game sessions in all of a fleet's remote locations. You can opt to filter out - individual locations if needed. - - - - The queue configuration also determines how FleetIQ selects the best available placement - for a new game session. Before searching for an available game server, FleetIQ first - prioritizes the queue's destinations and locations, with the best placement locations - on top. You can set up the queue to use the FleetIQ default prioritization or provide - an alternate set of priorities. - - - - To create a new queue, provide a name, timeout value, and a list of destinations. - Optionally, specify a sort configuration and/or a filter, and define a set of latency - cap policies. You can also include the ARN for an Amazon Simple Notification Service - (SNS) topic to receive notifications of game session placement activity. Notifications - using SNS or CloudWatch events is the preferred way to track placement activity. - - - - If successful, a new GameSessionQueue object is returned with an assigned - queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement - or StartMatchmaking, reference a queue's name or ARN. - - - - Learn more - - - - - Design a game session queue - - - - - Create a game session queue - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - - - - Gets and sets the property CustomEventData. - - Information to be added to all events that are related to this game session queue. - - - - - - - Gets and sets the property Destinations. - - A list of fleets and/or fleet aliases that can be used to fulfill game session placement - requests in the queue. Destinations are identified by either a fleet ARN or a fleet - alias ARN, and are listed in order of placement preference. - - - - - - Gets and sets the property FilterConfiguration. - - A list of locations where a queue is allowed to place new game sessions. Locations - are specified in the form of AWS Region codes, such as us-west-2. If - this parameter is not set, game sessions can be placed in any queue location. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with game session queue. Queue names must be - unique within each Region. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive game session placement notifications. See - - Setting up notifications for game session placement. - - - - - - Gets and sets the property PlayerLatencyPolicies. - - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver - low latency for most players in a game session. These policies ensure that no individual - player can be placed into a game with unreasonably high latency. Use multiple policies - to gradually relax latency requirements a step at a time. Multiple policies are applied - based on their maximum allowed latency, starting with the lowest value. - - - - - - Gets and sets the property PriorityConfiguration. - - Custom settings to use when prioritizing destinations and locations for game session - placements. This configuration replaces the FleetIQ default prioritization process. - Priority types that are not explicitly named will be automatically applied at the - end of the prioritization process. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new game session queue resource. Tags are developer-defined - key-value pairs. Tagging AWS resources are useful for resource management, access - management and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Gets and sets the property TimeoutInSeconds. - - The maximum time, in seconds, that a new game session placement request remains in - the queue. When a request exceeds this time, the game session placement changes to - a TIMED_OUT status. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionQueue. - - An object that describes the newly created game session queue. - - - - - - Container for the parameters to the CreateGameSession operation. - Creates a multiplayer game session for players in a specific fleet location. This - operation prompts an available server process to start a game session and retrieves - connection information for the new game session. As an alternative, consider using - the GameLift game session placement feature with - - - - with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to - optimize the placement process. - - - - When creating a game session, you specify exactly where you want to place it and provide - a set of game session configuration settings. The fleet must be in ACTIVE - status before a game session can be created in it. - - - - This operation can be used in the following ways: - -
  • - - To create a game session on an instance in a fleet's home Region, provide a fleet - or alias ID along with your game session configuration. - -
  • - - To create a game session on an instance in a fleet's remote location, provide a fleet - or alias ID and a location name, along with your game session configuration. - -
- - If successful, a workflow is initiated to start a new game session. A GameSession - object is returned containing the game session configuration and status. When the - status is ACTIVE, game session connection information is provided and - player sessions can be created for the game session. By default, newly created game - sessions are open to new players. You can restrict new player access by using UpdateGameSession - to change the game session's player session creation policy. - - - - Game session logs are retained for all active game sessions for 14 days. To access - the logs, call GetGameSessionLogUrl to download the log files. - - - - Available in GameLift Local. - - - - Learn more - - - - Start - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias associated with the fleet to create a game session - in. You can use either the alias ID or ARN value. Each request must reference either - a fleet ID or alias ID, but not both. - - - - - - Gets and sets the property CreatorId. - - A unique identifier for a player or entity creating the game session. This parameter - is required when requesting a new game session on a fleet with a resource creation - limit policy. This type of policy limits the number of concurrent active game sessions - that one player can create within a certain time span. GameLift uses the CreatorId - to evaluate the new request against the policy. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to create a game session in. You can use either - the fleet ID or ARN value. Each request must reference either a fleet ID or alias - ID, but not both. - - - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session. - - - - - - Gets and sets the property GameSessionId. - - This parameter is no longer preferred. Please use IdempotencyToken - instead. Custom string that uniquely identifies a request for a new game session. - Maximum token length is 48 characters. If provided, this string is included in the - new game session's ID. - - - - - - Gets and sets the property IdempotencyToken. - - Custom string that uniquely identifies the new game session request. This is useful - for ensuring that game session requests with the same idempotency token are processed - only once. Subsequent requests with the same string return the original GameSession - object, with an updated status. Maximum token length is 48 characters. If provided, - this string is included in the new game session's ID. A game session ARN has the following - format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom - ID string or idempotency token>. Idempotency tokens remain in use for 30 - days after a game session has ended; game session objects are retained for this time - period and then deleted. - - - - - - Gets and sets the property Location. - - A fleet's remote location to place the new game session in. If this parameter is not - set, the new game session is placed in the fleet's home Region. Specify a remote location - with an AWS Region code such as us-west-2. - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players that can be connected simultaneously to the game session. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a game session. Session names do not need - to be unique. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSession. - - Object that describes the newly created game session record. - - - - - - Container for the parameters to the CreateMatchmakingConfiguration operation. - Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - configuration sets out rules for matching players and forming teams. If you're also - using GameLift hosting, it defines how to start game sessions for each match. Your - matchmaking system can use multiple configurations to handle different game scenarios. - All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify - the matchmaking configuration to use and provide player attributes consistent with - that configuration. - - - - To create a matchmaking configuration, you must provide the following: configuration - name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies - how to evaluate players and find acceptable matches; whether player acceptance is - required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch - with GameLift hosting, you also need to identify the game session queue to use when - starting a game session for the match. - - - - In addition, you must set up an Amazon Simple Notification Service (SNS) topic to - receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. - An alternative method, continuously polling ticket status with DescribeMatchmaking, - is only suitable for games in development with low matchmaking usage. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - - Set up FlexMatch event notification - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property AcceptanceRequired. - - A flag that determines whether a match that was created with this configuration must - be accepted by the matched players. To require acceptance, set to TRUE. - With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE - to indicate when a completed potential match is waiting for player acceptance. - - - - - - Gets and sets the property AcceptanceTimeoutSeconds. - - The length of time (in seconds) to wait for players to accept a proposed match, if - acceptance is required. - - - - - - Gets and sets the property AdditionalPlayerCount. - - The number of player slots in a match to keep open for future players. For example, - if the configuration's rule set specifies a match for a single 12-person team, and - the additional player count is set to 2, only 10 players are selected for the match. - This parameter is not used if FlexMatchMode is set to STANDALONE. - - - - - - Gets and sets the property BackfillMode. - - The method used to backfill game sessions that are created with this matchmaking configuration. - Specify MANUAL when your game manages backfill requests manually or does - not use the match backfill feature. Specify AUTOMATIC to have GameLift - create a StartMatchBackfill request whenever a game session has one or more - open slots. Learn more about manual and automatic backfill in - Backfill Existing Games with FlexMatch. Automatic backfill is not available when - FlexMatchMode is set to STANDALONE. - - - - - - Gets and sets the property CustomEventData. - - Information to be added to all events related to this matchmaking configuration. - - - - - - Gets and sets the property Description. - - A human-readable description of the matchmaking configuration. - - - - - - Gets and sets the property FlexMatchMode. - - Indicates whether this matchmaking configuration is being used with GameLift hosting - or as a standalone matchmaking solution. - -
  • - - STANDALONE - FlexMatch forms matches and returns match information, including - players and team assignments, in a - MatchmakingSucceeded event. - -
  • - - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue - to start a game session for the match. - -
- - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used if FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used if FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionQueueArns. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift game session queue resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue - name>. Queues can be located in any Region. Queues are used to start new - GameLift-hosted game sessions for matches that are created with this matchmaking configuration. - If FlexMatchMode is set to STANDALONE, do not set this parameter. - - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking configuration. This name is used to identify - the configuration associated with a matchmaking request or ticket. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive matchmaking notifications. See - Setting up notifications for matchmaking for more information. - - - - - - Gets and sets the property RequestTimeoutSeconds. - - The maximum duration, in seconds, that a matchmaking ticket can remain in process - before timing out. Requests that fail due to timing out can be resubmitted as needed. - - - - - - Gets and sets the property RuleSetName. - - A unique identifier for the matchmaking rule set to use with this configuration. You - can use either the rule set name or ARN value. A matchmaking configuration can only - use rule sets that are defined in the same Region. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new matchmaking configuration resource. Tags are - developer-defined key-value pairs. Tagging AWS resources are useful for resource management, - access management and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Configuration. - - Object that describes the newly created matchmaking configuration. - - - - - - Container for the parameters to the CreateMatchmakingRuleSet operation. - Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of - match to create, such as the number and size of teams. It also sets the parameters - for acceptable player matches, such as minimum skill level or character type. A rule - set is used by a MatchmakingConfiguration. - - - - To create a matchmaking rule set, provide unique rule set name and the rule set body - in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration - they are used with. - - - - Since matchmaking rule sets cannot be edited, it is a good idea to check the rule - set syntax using ValidateMatchmakingRuleSet before creating a new rule set. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking rule set. A matchmaking configuration identifies - the rule set it uses by this name value. Note that the rule set name is different - from the optional name field in the rule set body. - - - - - - Gets and sets the property RuleSetBody. - - A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed - in JSON, but most elements support a description field. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined - key-value pairs. Tagging AWS resources are useful for resource management, access - management and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property RuleSet. - - The newly created matchmaking rule set. - - - - - - Container for the parameters to the CreatePlayerSession operation. - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to add a player to. - - - - - - Gets and sets the property PlayerData. - - Developer-defined information related to a player. GameLift does not use this data, - so it can be formatted as needed for use in the game. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player. Player IDs are developer-defined. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property PlayerSession. - - Object that describes the newly created player session record. - - - - - - Container for the parameters to the CreatePlayerSessions operation. - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to add players to. - - - - - - Gets and sets the property PlayerDataMap. - - Map of string pairs, each specifying a player ID and a set of developer-defined information - related to the player. Amazon GameLift does not use this data, so it can be formatted - as needed for use in the game. Any player data strings for player IDs that are not - included in the PlayerIds parameter are ignored. - - - - - - Gets and sets the property PlayerIds. - - List of unique identifiers for the players to be added. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property PlayerSessions. - - A collection of player session objects created for the added players. - - - - - - Container for the parameters to the CreateScript operation. - Creates a new script record for your Realtime Servers script. Realtime scripts are - JavaScript that provide configuration settings and optional custom game logic for - your game. The script is deployed when you create a Realtime Servers fleet to host - your game sessions. Script logic is executed during an active game session. - - - - To create a new script record, specify a script name and provide the script file(s). - The script files and all dependencies must be zipped into a single file. You can pull - the zip file from either of these locations: - -
  • - - A locally available directory. Use the ZipFile parameter for this option. - -
  • - - An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the - StorageLocation parameter for this option. You'll need to have an Identity - Access Management (IAM) role that allows the Amazon GameLift service to access your - S3 bucket. - -
- - If the call is successful, a new script record is created with a unique script ID. - If the script file is provided as a local file, the file is uploaded to an Amazon - GameLift-owned S3 bucket and the script record's storage location reflects this location. - If the script file is provided as an S3 bucket, Amazon GameLift accesses the file - at this storage location as needed for deployment. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Set - Up a Role for Amazon GameLift Access - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a script. Script names do not need to - be unique. You can use UpdateScript to change this value later. - - - - - - Gets and sets the property StorageLocation. - - The location of the Amazon S3 bucket where a zipped file containing your Realtime - scripts is stored. The storage location must specify the Amazon S3 bucket name, the - zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the - Amazon S3 storage location. The S3 bucket must be in the same Region where you want - to create a new script. By default, Amazon GameLift uploads the latest version of - the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion - parameter to specify an earlier version. - - - - - - Gets and sets the property Tags. - - A list of labels to assign to the new script resource. Tags are developer-defined - key-value pairs. Tagging AWS resources are useful for resource management, access - management and cost allocation. For more information, see - Tagging AWS Resources in the AWS General Reference. Once the resource is - created, you can use TagResource, UntagResource, and ListTagsForResource - to add, remove, and view tags. The maximum tag limit may be lower than stated. See - the AWS General Reference for actual tagging limits. - - - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. You can use UpdateScript to change this value later. - - - - - - - Gets and sets the property ZipFile. - - A data object containing your Realtime scripts and dependencies as a zip file. The - zip file can have one or multiple files. Maximum size of a zip file is 5 MB. - - - - When using the AWS CLI tool to create a script, this parameter is set to the zip file - name. It must be prepended with the string "fileb://" to indicate that the file data - is a binary object. For example: --zip-file fileb://myRealtimeScript.zip. - - - - - - This is the response object from the CreateScript operation. - - - - - Gets and sets the property Script. - - The newly created script record with a unique script ID and ARN. The new script's - storage location reflects an Amazon S3 location: (1) If the script was uploaded from - an S3 bucket under your account, the storage location reflects the information that - was provided in the CreateScript request; (2) If the script file was uploaded - from a local zip file, the storage location reflects an S3 location controls by the - Amazon GameLift service. - - - - - - Container for the parameters to the CreateVpcPeeringAuthorization operation. - Requests authorization to create or delete a peer connection between the VPC for your - Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering - enables the game servers on your fleet to communicate directly with other AWS resources. - Once you've received authorization, call CreateVpcPeeringConnection to establish - the peering connection. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - You can peer with VPCs that are owned by any AWS account you have access to, including - the account that you use to manage your Amazon GameLift fleets. You cannot peer with - VPCs that are in different Regions. - - - - To request authorization to create a connection, call this operation from the AWS - account with the VPC that you want to peer to your Amazon GameLift fleet. For example, - to enable your game servers to retrieve data from a DynamoDB table, use the account - that manages that DynamoDB resource. Identify the following values: (1) The ID of - the VPC that you want to peer with, and (2) the ID of the AWS account that you use - to manage Amazon GameLift. If successful, VPC peering is authorized for the specified - VPC. - - - - To request authorization to delete a connection, call this operation from the AWS - account with the VPC that is peered with your Amazon GameLift fleet. Identify the - following values: (1) VPC ID that you want to delete the peering connection for, and - (2) ID of the AWS account that you use to manage Amazon GameLift. - - - - The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. - You must create or delete the peering connection while the authorization is valid. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property GameLiftAwsAccountId. - - A unique identifier for the AWS account that you use to manage your GameLift fleet. - You can find your Account ID in the AWS Management Console under account settings. - - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property VpcPeeringAuthorization. - - Details on the requested VPC peering authorization, including expiration. - - - - - - Container for the parameters to the CreateVpcPeeringConnection operation. - Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS - account with the VPC for your Amazon GameLift fleet. VPC peering enables the game - servers on your fleet to communicate directly with other AWS resources. You can peer - with VPCs in any AWS account that you have access to, including the account that you - use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different - Regions. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - Before calling this operation to establish the peering connection, you first need - to call CreateVpcPeeringAuthorization and identify the VPC you want to peer - with. Once the authorization for the specified VPC is issued, you have 24 hours to - establish the connection. These two operations handle all tasks necessary to peer - the two VPCs, including acceptance, updating routing tables, etc. - - - - To establish the connection, call this operation from the AWS account that is used - to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of - the fleet you want to be enable a VPC peering connection for; (2) The AWS account - with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer - with. This operation is asynchronous. If successful, a VpcPeeringConnection - request is created. You can use continuous polling to track the request's status using - DescribeVpcPeeringConnections, or by monitoring fleet events for success or - failure using DescribeFleetEvents. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet. You can use either the fleet ID or ARN value. This - tells Amazon GameLift which GameLift VPC to peer with. - - - - - - Gets and sets the property PeerVpcAwsAccountId. - - A unique identifier for the AWS account with the VPC that you want to peer your Amazon - GameLift fleet with. You can find your Account ID in the AWS Management Console under - account settings. - - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - This is the response object from the CreateVpcPeeringConnection operation. - - - - - Container for the parameters to the DeleteAlias operation. - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier of the alias that you want to delete. You can use either the alias - ID or ARN value. - - - - - - This is the response object from the DeleteAlias operation. - - - - - Container for the parameters to the DeleteBuild operation. - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build to delete. You can use either the build ID or ARN - value. - - - - - - This is the response object from the DeleteBuild operation. - - - - - Container for the parameters to the DeleteFleetLocations operation. - Removes locations from a multi-location fleet. When deleting a location, all game - server process and all instances that are still active in the location are shut down. - - - - - To delete fleet locations, identify the fleet ID and provide a list of the locations - to be deleted. - - - - If successful, GameLift sets the location status to DELETING, and begins - to shut down existing server processes and terminate instances in each location being - deleted. When completed, the location status changes to TERMINATED. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to delete locations for. You can use either the - fleet ID or ARN value. - - - - - - Gets and sets the property Locations. - - The list of fleet locations to delete. Specify locations in the form of an AWS Region - code, such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that location attributes are being deleted for. - - - - - - Gets and sets the property LocationStates. - - The remote locations that are being deleted, with each location status set to DELETING. - - - - - - Container for the parameters to the DeleteFleet operation. - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or - ARN value. - - - - - - This is the response object from the DeleteFleet operation. - - - - - Container for the parameters to the DeleteGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Terminates a game server group and permanently deletes the game server group record. - You have several options for how these resources are impacted when deleting the game - server group. Depending on the type of delete operation selected, this operation might - affect these resources: - -
  • - - The game server group - -
  • - - The corresponding Auto Scaling group - -
  • - - All game servers that are currently running in the group - -
- - To delete a game server group, identify the game server group to delete and specify - the type of delete operation to initiate. Game server groups can only be deleted if - they are in ACTIVE or ERROR status. - - - - If the delete request is successful, a series of operations are kicked off. The game - server group status is changed to DELETE_SCHEDULED, which prevents new - game servers from being registered and stops automatic scaling activity. Once all - game servers in the game server group are deregistered, GameLift FleetIQ can begin - deleting resources. If any of the delete operations fail, the game server group is - placed in ERROR status. - - - - GameLift FleetIQ emits delete events to Amazon CloudWatch. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property DeleteOption. - - The type of delete to perform. Options include the following: - -
  • - - SAFE_DELETE – (default) Terminates the game server group and EC2 Auto - Scaling group only when it has no game servers that are in UTILIZED status. - -
  • - - FORCE_DELETE – Terminates the game server group, including all active - game servers regardless of their utilization status, and the EC2 Auto Scaling group. - - -
  • - - RETAIN – Does a safe delete of the game server group but retains the - EC2 Auto Scaling group as is. - -
- - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - This is the response object from the DeleteGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - An object that describes the deleted game server group resource, with status updated - to DELETE_SCHEDULED. - - - - - - Container for the parameters to the DeleteGameSessionQueue operation. - Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement - requests that reference the queue will fail. To delete a queue, specify the queue - name. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with game session queue. Queue names must be - unique within each Region. You can use either the queue ID or ARN value. - - - - - - This is the response object from the DeleteGameSessionQueue operation. - - - - - Container for the parameters to the DeleteMatchmakingConfiguration operation. - Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - configuration name. A matchmaking configuration cannot be deleted if it is being used - in any active matchmaking tickets. - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking configuration. You can use either the configuration - name or ARN value. - - - - - - This is the response object from the DeleteMatchmakingConfiguration operation. - - - - - Container for the parameters to the DeleteMatchmakingRuleSet operation. - Deletes an existing matchmaking rule set. To delete the rule set, provide the rule - set name. Rule sets cannot be deleted if they are currently being used by a matchmaking - configuration. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set - name is different from the optional "name" field in the rule set body.) You can use - either the rule set name or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Container for the parameters to the DeleteScalingPolicy operation. - Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - GameLift removes all record of it. To delete a scaling policy, specify both the scaling - policy name and the fleet ID it is associated with. - - - - To temporarily suspend scaling policies, call StopFleetActions. This operation - suspends all policies for the fleet. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or - ARN value. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet's scaling policy. Policy names - do not need to be unique. - - - - - - This is the response object from the DeleteScalingPolicy operation. - - - - - Container for the parameters to the DeleteScript operation. - Deletes a Realtime script. This operation permanently deletes the script record. If - script files were uploaded, they are also deleted (files stored in an S3 bucket are - not deleted). - - - - To delete a script, specify the script ID. Before deleting a script, be sure to terminate - all fleets that are deployed with the script being deleted. Fleet instances periodically - check for script updates, and if the script record no longer exists, the instance - will go into an error state and be unable to host game sessions. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script to delete. You can use either the script - ID or ARN value. - - - - - - This is the response object from the DeleteScript operation. - - - - - Container for the parameters to the DeleteVpcPeeringAuthorization operation. - Cancels a pending VPC peering authorization for the specified VPC. If you need to - delete an existing VPC peering connection, call DeleteVpcPeeringConnection. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property GameLiftAwsAccountId. - - A unique identifier for the AWS account that you use to manage your GameLift fleet. - You can find your Account ID in the AWS Management Console under account settings. - - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - This is the response object from the DeleteVpcPeeringAuthorization operation. - - - - - Container for the parameters to the DeleteVpcPeeringConnection operation. - Removes a VPC peering connection. To delete the connection, you must have a valid - authorization for the VPC peering connection that you want to delete. You can check - for an authorization by calling DescribeVpcPeeringAuthorizations or request - a new one using CreateVpcPeeringAuthorization. - - - - Once a valid authorization exists, call this operation from the AWS account that is - used to manage the Amazon GameLift fleets. Identify the connection to delete by the - connection ID and fleet ID. If successful, the connection is removed. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet. This fleet specified must match the fleet referenced - in the VPC peering connection record. You can use either the fleet ID or ARN value. - - - - - - Gets and sets the property VpcPeeringConnectionId. - - A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection - object, which can be retrieved by calling DescribeVpcPeeringConnections. - - - - - - This is the response object from the DeleteVpcPeeringConnection operation. - - - - - Container for the parameters to the DeregisterGameServer operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Removes the game server from a game server group. As a result of this operation, the - deregistered game server can no longer be claimed and will not be returned in a list - of active game servers. - - - - To deregister a game server, specify the game server group and game server ID. If - successful, this operation emits a CloudWatch event with termination timestamp and - reason. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server to deregister. - - - - - - This is the response object from the DeregisterGameServer operation. - - - - - Container for the parameters to the DescribeAlias operation. - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property AliasId. - - The unique identifier for the fleet alias that you want to retrieve. You can use either - the alias ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Alias. - - The requested alias resource. - - - - - - Container for the parameters to the DescribeBuild operation. - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build to retrieve properties for. You can use either the - build ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Build. - - Set of properties describing the requested build. - - - - - - Container for the parameters to the DescribeEC2InstanceLimits operation. - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - - - - Gets and sets the property EC2InstanceType. - - Name of an EC2 instance type that is supported in GameLift. A fleet instance type - determines the computing resources of each instance in the fleet, including CPU, memory, - storage, and networking capacity. Do not specify a value for this parameter to retrieve - limits for all instance types. - - - - - - Gets and sets the property Location. - - The name of a remote location to request instance limits for, in the form of an AWS - Region code such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property EC2InstanceLimits. - - The maximum number of instances for the specified instance type. - - - - - - Container for the parameters to the DescribeFleetAttributes operation. - Retrieves core fleet-wide properties, including the computing hardware and deployment - configuration for all instances in the fleet. - - - - This operation can be used in the following ways: - -
  • - - To get attributes for one or more specific fleets, provide a list of fleet IDs or - fleet ARNs. - -
  • - - To get attributes for all fleets, do not provide a fleet identifier. - -
- - When requesting attributes for multiple fleets, use the pagination parameters to retrieve - results as a set of sequential pages. - - - - If successful, a FleetAttributes object is returned for each fleet requested, - unless the fleet identifier is not found. - - - - Some API operations limit the number of fleet IDs that allowed in one request. If - a request exceeds this limit, the request fails and the error message contains the - maximum allowed number. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property FleetIds. - - A list of unique fleet identifiers to retrieve attributes for. You can use either - the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include - this parameter. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetAttributes. - - A collection of objects containing attribute metadata for each requested fleet ID. - Attribute objects are returned only for fleets that currently exist. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeFleetCapacity operation. - Retrieves the resource capacity settings for one or more fleets. The data returned - includes the current fleet capacity (number of EC2 instances), and settings that can - control how capacity scaling. For fleets with remote locations, this operation retrieves - data for the fleet's home Region only. See DescribeFleetLocationCapacity to - get capacity settings for a fleet's remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get capacity data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get capacity data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetCapacity object is returned for each requested fleet - ID. Each FleetCapacity object includes a Location property, which is - set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - are returned only for fleets that currently exist. - - - - Some API operations may limit the number of fleet IDs that are allowed in one request. - If a request exceeds this limit, the request fails and the error message includes - the maximum allowed. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property FleetIds. - - A unique identifier for the fleet(s) to retrieve capacity information for. You can - use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity - information for all fleets. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetCapacity. - - A collection of objects that contains capacity information for each requested fleet - ID. Capacity objects are returned only for fleets that currently exist. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeFleetEvents operation. - Retrieves entries from a fleet's event log. Fleet events are initiated by changes - in status, such as during fleet creation and termination, changes in capacity, etc. - If a fleet has multiple locations, events are also initiated by changes to status - and capacity in remote locations. - - - - You can specify a time range to limit the result set. Use the pagination parameters - to retrieve results as a set of sequential pages. - - - - If successful, a collection of event log entries matching the request are returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property EndTime. - - The most recent date to retrieve event logs for. If no end time is specified, this - call returns entries from the specified start time up to the present. Format is a - number expressed in Unix time as milliseconds (ex: "1469498468.057"). - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to get event logs for. You can use either the fleet - ID or ARN value. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property StartTime. - - The earliest date to retrieve event logs for. If no start time is specified, this - call returns entries starting from when the fleet was created to the specified end - time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057"). - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Events. - - A collection of objects containing event log entries for the specified fleet. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeFleetLocationAttributes operation. - Retrieves information on a fleet's remote locations, including life-cycle status and - any suspended fleet activity. - - - - This operation can be used in the following ways: - -
  • - - To get data for specific locations, provide a fleet identifier and a list of locations. - Location data is returned in the order that it is requested. - -
  • - - To get data for all locations, provide a fleet identifier only. Location data is returned - in no particular order. - -
- - When requesting attributes for multiple locations, use the pagination parameters to - retrieve results as a set of sequential pages. - - - - If successful, a LocationAttributes object is returned for each requested - location. If the fleet does not have a requested location, no information is returned. - This operation does not return the home Region. To get information on a fleet's home - Region, call DescribeFleetAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve remote locations for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. This limit is not currently enforced. - - - - - - - Gets and sets the property Locations. - - A list of fleet locations to retrieve information for. Specify locations in the form - of an AWS Region code, such as us-west-2. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that location attributes were requested for. - - - - - - Gets and sets the property LocationAttributes. - - Location-specific information on the requested fleet's remote locations. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeFleetLocationCapacity operation. - Retrieves the resource capacity settings for a fleet location. The data returned includes - the current capacity (number of EC2 instances) and some scaling settings for the requested - fleet location. Use this operation to retrieve capacity information for a fleet's - remote location or home Region (you can also retrieve home Region capacity by calling - DescribeFleetCapacity). - - - - To retrieve capacity data, identify a fleet and location. - - - - If successful, a FleetCapacity object is returned for the requested fleet - location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to request location capacity for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property Location. - - The fleet location to retrieve capacity information for. Specify a location in the - form of an AWS Region code, such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetCapacity. - - Resource capacity information for the requested fleet location. Capacity objects are - returned only for fleets and locations that currently exist. - - - - - - Container for the parameters to the DescribeFleetLocationUtilization operation. - Retrieves current usage data for a fleet location. Utilization data provides a snapshot - of current game hosting activity at the requested location. Use this operation to - retrieve utilization information for a fleet's remote location or home Region (you - can also retrieve home Region utilization by calling DescribeFleetUtilization). - - - - To retrieve utilization data, identify a fleet and location. - - - - If successful, a FleetUtilization object is returned for the requested - fleet location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to request location utilization for. You can use - either the fleet ID or ARN value. - - - - - - Gets and sets the property Location. - - The fleet location to retrieve utilization information for. Specify a location in - the form of an AWS Region code, such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetUtilization. - - Utilization information for the requested fleet location. Utilization objects are - returned only for fleets and locations that currently exist. - - - - - - Container for the parameters to the DescribeFleetPortSettings operation. - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve port settings for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property Location. - - A remote location to check for status of port setting updates. Use the AWS Region - code format, such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that was requested. - - - - - - Gets and sets the property InboundPermissions. - - The port settings for the requested fleet ID. - - - - - - Gets and sets the property Location. - - The requested fleet location, expressed as an AWS Region code, such as us-west-2. - - - - - - - Gets and sets the property UpdateStatus. - - The current status of updates to the fleet's port settings in the requested fleet - location. A status of PENDING_UPDATE indicates that an update was requested - for the fleet but has not yet been completed for the location. - - - - - - Container for the parameters to the DescribeFleetUtilization operation. - Retrieves utilization statistics for one or more fleets. Utilization data provides - a snapshot of how the fleet's hosting resources are currently being used. For fleets - with remote locations, this operation retrieves data for the fleet's home Region only. - See DescribeFleetLocationUtilization to get utilization statistics for a fleet's - remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get utilization data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get utilization data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetUtilization object is returned for each requested fleet - ID, unless the fleet identifier is not found. Each fleet utilization object includes - a Location property, which is set to the fleet's home Region. - - - - Some API operations may limit the number of fleet IDs allowed in one request. If a - request exceeds this limit, the request fails and the error message includes the maximum - allowed. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - GameLift - Metrics for Fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property FleetIds. - - A unique identifier for the fleet(s) to retrieve utilization data for. You can use - either the fleet ID or ARN value. To retrieve attributes for all current fleets, do - not include this parameter. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. This parameter is ignored when the request - specifies one or a list of fleet IDs. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetUtilization. - - A collection of objects containing utilization information for each requested fleet - ID. Utilization objects are returned only for fleets that currently exist. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on a game server group. This operation returns only properties - related to GameLift FleetIQ. To view or update properties for the corresponding Auto - Scaling group, such as launch template, auto scaling policies, and maximum/minimum - group size, access the Auto Scaling group directly. - - - - To get attributes for a game server group, provide a group name or ARN value. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - This is the response object from the DescribeGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - An object with the property settings for the requested game server group resource. - - - - - - - Container for the parameters to the DescribeGameServerInstances operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves status information about the Amazon EC2 instances associated with a GameLift - FleetIQ game server group. Use this operation to detect when instances are active - or not available to host new game servers. If you are looking for instance configuration - information, call DescribeGameServerGroup or access the corresponding Auto - Scaling group properties. - - - - To request status for all instances in the game server group, provide a game server - group ID only. To request status for specific instances, provide the game server group - ID and one or more instance IDs. Use the pagination parameters to retrieve results - in sequential segments. If successful, a collection of GameServerInstance - objects is returned. - - - - This operation is not designed to be called with every game server claim request; - this practice can cause you to exceed your API limit, which results in errors. Instead, - as a best practice, cache the results and refresh your cache no more than once every - 10 seconds. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - Gets and sets the property InstanceIds. - - The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character - format, for example: i-1234567890abcdef0. To retrieve all instances in - the game server group, leave this parameter empty. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the - token that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - This is the response object from the DescribeGameServerInstances operation. - - - - - Gets and sets the property GameServerInstances. - - The collection of requested game server instances. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeGameServer operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information for a registered game server. Information includes game server - status, health check info, and the instance that the game server is running on. - - - - To retrieve game server information, specify the game server ID. If successful, the - requested game server object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server information to be retrieved. - - - - - - This is the response object from the DescribeGameServer operation. - - - - - Gets and sets the property GameServer. - - Object that describes the requested game server. - - - - - - Container for the parameters to the DescribeGameSessionDetails operation. - Retrieves additional game session properties, including the game session protection - policy in force, a set of one or more game sessions in a specific fleet location. - You can optionally filter the results by current game session status. Alternatively, - use SearchGameSessions to request a set of active game sessions that are filtered - by certain criteria. To retrieve all game session properties, use DescribeGameSessions. - - - - - This operation can be used in the following ways: - -
  • - - To retrieve details for all game sessions that are currently running on all locations - in a fleet, provide a fleet or alias ID, with an optional status filter. This approach - returns details from the fleet's home Region and all remote locations. - -
  • - - To retrieve details for all game sessions that are currently running on a specific - fleet location, provide a fleet or alias ID and a location name, with optional status - filter. The location can be the fleet's home Region or any remote location. - -
  • - - To retrieve details for a specific game session, provide the game session ID. This - approach looks for the game session ID in all fleets that reside in the AWS Region - defined in the request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSessionDetail object is returned for each game session - that matches the request. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias associated with the fleet to retrieve all game sessions - for. You can use either the alias ID or ARN value. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve all game sessions active on the fleet. - You can use either the fleet ID or ARN value. - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to retrieve. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Location. - - A fleet location to get game sessions for. You can specify a fleet's home Region or - a remote location. Use the AWS Region code format, such as us-west-2. - - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property StatusFilter. - - Game session status to filter results on. Possible game session statuses include ACTIVE, - TERMINATED, ACTIVATING and TERMINATING (the - last two are transitory). - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionDetails. - - A collection of properties for each game session that matches the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeGameSessionPlacement operation. - Retrieves information, including current status, about a game session placement request. - - - - - To get game session placement details, specify the placement ID. - - - - If successful, a GameSessionPlacement object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property PlacementId. - - A unique identifier for a game session placement to retrieve. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionPlacement. - - Object that describes the requested game session placement. - - - - - - Container for the parameters to the DescribeGameSessionQueues operation. - Retrieves the properties for one or more game session queues. When requesting multiple - queues, use the pagination parameters to retrieve results as a set of sequential pages. - If successful, a GameSessionQueue object is returned for each requested queue. - When specifying a list of queues, objects are returned only for queues that currently - exist in the Region. - - - - Learn more - - - - - View Your Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. You can request up to 50 results. - - - - - - Gets and sets the property Names. - - A list of queue names to retrieve information for. You can use either the queue ID - or ARN value. To request settings for all queues, leave this parameter empty. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionQueues. - - A collection of objects that describe the requested game session queues. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeGameSessions operation. - Retrieves a set of one or more game sessions in a specific fleet location. You can - optionally filter the results by current game session status. Alternatively, use SearchGameSessions - to request a set of active game sessions that are filtered by certain criteria. To - retrieve the protection policy for game sessions, use DescribeGameSessionDetails. - - - - This operation can be used in the following ways: - -
  • - - To retrieve all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID, with an optional status filter. This approach returns - all game sessions in the fleet's home Region and all remote locations. - -
  • - - To retrieve all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name, with optional status filter. The - location can be the fleet's home Region or any remote location. - -
  • - - To retrieve a specific game session, provide the game session ID. This approach looks - for the game session ID in all fleets that reside in the AWS Region defined in the - request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. - - - - Available in GameLift Local. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias associated with the fleet to retrieve game sessions - for. You can use either the alias ID or ARN value. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve game sessions for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to retrieve. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Location. - - A fleet location to get game session details for. You can specify a fleet's home Region - or a remote location. Use the AWS Region code format, such as us-west-2. - - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property StatusFilter. - - Game session status to filter results on. You can filter on the following states: - ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. - The last two are transitory and used for only very brief periods of time. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessions. - - A collection of properties for each game session that matches the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeInstances operation. - Retrieves information about a fleet's instances, including instance IDs, connection - data, and status. - - - - This operation can be used in the following ways: - -
  • - - To get information on all instances that are deployed to a fleet's home Region, provide - the fleet ID. - -
  • - - To get information on all instances that are deployed to a fleet's remote location, - provide the fleet ID and location name. - -
  • - - To get information on a specific instance in a fleet, provide the fleet ID and instance - ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, an Instance object is returned for each requested instance. - Instances are not returned in any particular order. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve instance information for. You can use - either the fleet ID or ARN value. - - - - - - Gets and sets the property InstanceId. - - A unique identifier for an instance to retrieve. Specify an instance ID or leave blank - to retrieve all instances in the fleet. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Location. - - The name of a location to retrieve instance information for, in the form of an AWS - Region code such as us-west-2. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Instances. - - A collection of objects containing properties for each instance returned. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeMatchmakingConfigurations operation. - Retrieves the details of FlexMatch matchmaking configurations. - - - - This operation offers the following options: (1) retrieve all matchmaking configurations, - (2) retrieve configurations for a specified list, or (3) retrieve all configurations - that use a specified rule set name. When requesting multiple items, use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a configuration is returned for each requested name. When specifying - a list of names, only configurations that currently exist are returned. - - - - Learn more - - - - - Setting up FlexMatch matchmakers - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. This parameter is limited to 10. - - - - - - Gets and sets the property Names. - - A unique identifier for the matchmaking configuration(s) to retrieve. You can use - either the configuration name or ARN value. To request all existing configurations, - leave this parameter empty. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property RuleSetName. - - A unique identifier for the matchmaking rule set. You can use either the rule set - name or ARN value. Use this parameter to retrieve all matchmaking configurations that - use this rule set. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Configurations. - - A collection of requested matchmaking configurations. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the DescribeMatchmaking operation. - Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, - including--after a successful match is made--connection information for the resulting - new game session. - - - - To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - is successful, a ticket object is returned for each requested ID that currently exists. - - - - This operation is not designed to be continually called to track matchmaking ticket - status. This practice can cause you to exceed your API limit, which results in errors. - Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to - receive notifications, and provide the topic ARN in the matchmaking configuration. - Continuously poling ticket status with DescribeMatchmaking should only be used - for games in development with low matchmaking usage. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - - - - Gets and sets the property TicketIds. - - A unique identifier for a matchmaking ticket. You can include up to 10 ID values. - - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property TicketList. - - A collection of existing matchmaking ticket objects matching the request. - - - - - - Container for the parameters to the DescribeMatchmakingRuleSets operation. - Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - rule sets for the Region, or provide a list of one or more rule set names. When requesting - multiple items, use the pagination parameters to retrieve results as a set of sequential - pages. If successful, a rule set is returned for each requested name. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Names. - - A list of one or more matchmaking rule set names to retrieve details for. (Note: The - rule set name is different from the optional "name" field in the rule set body.) You - can use either the rule set name or ARN value. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Gets and sets the property RuleSets. - - A collection of requested matchmaking rule set objects. - - - - - - Container for the parameters to the DescribePlayerSessions operation. - Retrieves properties for one or more player sessions. - - - - This action can be used in the following ways: - -
  • - - To retrieve a specific player session, provide the player session ID only. - -
  • - - To retrieve all player sessions in a game session, provide the game session ID only. - -
  • - - To retrieve all player sessions for a specific player, provide a player ID only. - -
- - To request player sessions, specify either a player session ID, game session ID, or - player ID. You can filter this request by player session status. Use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a PlayerSession object is returned for each session that - matches the request. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to retrieve player sessions for. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. If a player session ID is specified, - this parameter is ignored. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. If a player session ID is specified, this - parameter is ignored. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player to retrieve player sessions for. - - - - - - Gets and sets the property PlayerSessionId. - - A unique identifier for a player session to retrieve. - - - - - - Gets and sets the property PlayerSessionStatusFilter. - - Player session status to filter results on. - - - - Possible player session statuses include the following: - -
  • - - RESERVED -- The player session request has been received, but the player has - not yet connected to the server process and/or been validated. - -
  • - - ACTIVE -- The player has been validated by the server process and is currently - connected. - -
  • - - COMPLETED -- The player connection has been dropped. - -
  • - - TIMEDOUT -- A player session request was received, but the player did not - connect and/or was not validated within the timeout limit (60 seconds). - -
- - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Gets and sets the property PlayerSessions. - - A collection of objects containing properties for each player session that matches - the request. - - - - - - Container for the parameters to the DescribeRuntimeConfiguration operation. - Retrieves a fleet's runtime configuration settings. The runtime configuration tells - GameLift which server processes to run (and how) on each instance in the fleet. - - - - To get the runtime configuration that is currently in forces for a fleet, provide - the fleet ID. - - - - If successful, a RuntimeConfiguration object is returned for the requested - fleet. If the requested fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Running - multiple processes on a fleet - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to get the runtime configuration for. You can use - either the fleet ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property RuntimeConfiguration. - - Instructions that describe how server processes should be launched and maintained - on each instance in the fleet. - - - - - - Container for the parameters to the DescribeScalingPolicies operation. - Retrieves all scaling policies applied to a fleet. - - - - To get a fleet's scaling policies, specify the fleet ID. You can filter this request - by policy status, such as to retrieve only active scaling policies. Use the pagination - parameters to retrieve results as a set of sequential pages. If successful, set of - ScalingPolicy objects is returned for the fleet. - - - - A fleet may have all of its scaling policies suspended (StopFleetActions). - This operation does not affect the status of the scaling policies, which remains ACTIVE. - To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes - and check the stopped actions. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to retrieve scaling policies for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Location. - - CONTENT TODO - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property StatusFilter. - - Scaling policy status to filter results on. A scaling policy is only in force when - in an ACTIVE status. - -
  • - - ACTIVE -- The scaling policy is currently in force. - -
  • - - UPDATEREQUESTED -- A request to update the scaling policy has been received. - -
  • - - UPDATING -- A change is being made to the scaling policy. - -
  • - - DELETEREQUESTED -- A request to delete the scaling policy has been received. - -
  • - - DELETING -- The scaling policy is being deleted. - -
  • - - DELETED -- The scaling policy has been deleted. - -
  • - - ERROR -- An error occurred in creating the policy. It should be removed and - recreated. - -
- - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Gets and sets the property ScalingPolicies. - - A collection of objects containing the scaling policies matching the request. - - - - - - Container for the parameters to the DescribeScript operation. - Retrieves properties for a Realtime script. - - - - To request a script record, specify the script ID. If successful, an object containing - the script properties is returned. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script to retrieve properties for. You can use - either the script ID or ARN value. - - - - - - This is the response object from the DescribeScript operation. - - - - - Gets and sets the property Script. - - A set of properties describing the requested script. - - - - - - Container for the parameters to the DescribeVpcPeeringAuthorizations operation. - Retrieves valid VPC peering authorizations that are pending for the AWS account. This - operation returns all VPC peering authorizations and requests for peering. This includes - those initiated and received by this account. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - This is the response object from the DescribeVpcPeeringAuthorizations operation. - - - - - Gets and sets the property VpcPeeringAuthorizations. - - A collection of objects that describe all valid VPC peering operations for the current - AWS account. - - - - - - Container for the parameters to the DescribeVpcPeeringConnections operation. - Retrieves information on VPC peering connections. Use this operation to get peering - information for all fleets or for one specific fleet ID. - - - - To retrieve connection information, call this operation from the AWS account that - is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter - empty to retrieve all connection records. If successful, the retrieved information - includes both active and pending connections. Active connections identify the IpV4 - CIDR block that the VPC uses to connect. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet. You can use either the fleet ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property VpcPeeringConnections. - - A collection of VPC peering connection records that match the request. - - - - - - Player information for use when creating player sessions using a game session placement - request with StartGameSessionPlacement. - - - - - Gets and sets the property PlayerData. - - Developer-defined information related to a player. GameLift does not use this data, - so it can be formatted as needed for use in the game. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player to associate with the player session. - - - - - - Resource capacity settings. Fleet capacity is measured in EC2 instances. Pending and - terminating counts are non-zero when the fleet capacity is adjusting to a scaling - event or if access to resources is temporarily affected. - - - - EC2 instance counts are part of FleetCapacity. - - - - - - Gets and sets the property ACTIVE. - - Actual number of instances that are ready to host game sessions. - - - - - - Gets and sets the property DESIRED. - - Ideal number of active instances. GameLift will always try to maintain the desired - number of instances. Capacity is scaled up or down by changing the desired instances. - - - - - - - Gets and sets the property IDLE. - - Number of active instances that are not currently hosting a game session. - - - - - - Gets and sets the property MAXIMUM. - - The maximum instance count value allowed. - - - - - - Gets and sets the property MINIMUM. - - The minimum instance count value allowed. - - - - - - Gets and sets the property PENDING. - - Number of instances that are starting but not yet active. - - - - - - Gets and sets the property TERMINATING. - - Number of instances that are no longer active but haven't yet been terminated. - - - - - - The GameLift service limits for an EC2 instance type and current utilization. GameLift - allows AWS accounts a maximum number of instances, per instance type, per AWS Region - or location, for use with GameLift. You can request an limit increase for your account - by using the Service limits page in the GameLift console. - - - - Related actions - - - - DescribeEC2InstanceLimits - - - - - - Gets and sets the property CurrentInstances. - - The number of instances for the specified type and location that are currently being - used by the AWS account. - - - - - - Gets and sets the property EC2InstanceType. - - The name of an EC2 instance type. See Amazon - EC2 Instance Types for detailed descriptions. - - - - - - Gets and sets the property InstanceLimit. - - The number of instances that is allowed for the specified instance type and location. - - - - - - Gets and sets the property Location. - - An AWS Region code, such as us-west-2. - - - - - - Log entry describing an event that involves GameLift resources (such as a fleet). - In addition to tracking activity, event codes and messages can provide additional - information for troubleshooting and debugging problems. - - - - Related actions - - - - DescribeFleetEvents - - - - - - Gets and sets the property EventCode. - - The type of event being logged. - - - - Fleet creation events (ordered by fleet creation activity): - -
  • - - FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. - Event messaging includes the fleet ID. - -
  • - - FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. - The compressed build has started downloading to a fleet instance for installation. - -
  • - - FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance. - -
  • - - FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded - to an instance, and the build files are now being extracted from the uploaded build - and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE - status. Logs for this stage display a list of the files that are extracted and saved - on the instance. Access the logs by using the URL in PreSignedLogUrl. - -
  • - - FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, - and the GameLift is now running the build's install script (if one is included). Failure - in this stage prevents a fleet from moving to ACTIVE status. Logs for - this stage list the installation steps and whether or not the install completed successfully. - Access the logs by using the URL in PreSignedLogUrl. - -
  • - - FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and - the GameLift is now verifying that the game server launch paths, which are specified - in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift - tries to launch a game server process and waits for the process to report ready. Failures - in this stage prevent a fleet from moving to ACTIVE status. Logs for - this stage list the launch paths in the runtime configuration and indicate whether - each is found. Access the logs by using the URL in PreSignedLogUrl. - -
  • - - FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. - -
  • - - FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration - failed because the executable specified in a launch path does not exist on the instance. - -
  • - - FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. - -
  • - - FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration - failed because the executable specified in a launch path failed to run on the fleet - instance. - -
  • - - FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. - - -
  • - - FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps - in the fleet activation process. This event code indicates that the game build was - successfully downloaded to a fleet instance, built, and validated, but was not able - to start a server process. Learn more at - Debug Fleet Creation Issues - -
  • - - FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. - The fleet is now ready to host game sessions. - -
- - VPC peering events: - -
  • - - FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between - the VPC for an GameLift fleet and a VPC in your AWS account. - -
  • - - FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details - and status information (see DescribeVpcPeeringConnections) provide additional - detail. A common reason for peering failure is that the two VPCs have overlapping - CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC - in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html - - -
  • - - FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted. - -
- - Spot instance events: - -
  • - - INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute - notification. - -
- - Other fleet events: - -
  • - - FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired - instances, minimum/maximum scaling limits). Event messaging includes the new capacity - settings. - -
  • - - FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's - game session protection policy setting. Event messaging includes both the old and - new policy setting. - -
  • - - FLEET_DELETED -- A request to delete a fleet was initiated. - -
  • - - GENERIC_EVENT -- An unspecified event has occurred. - -
- - - - - Gets and sets the property EventId. - - A unique identifier for a fleet event. - - - - - - Gets and sets the property EventTime. - - Time stamp indicating when this event occurred. Format is a number expressed in Unix - time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Message. - - Additional information related to the event. - - - - - - Gets and sets the property PreSignedLogUrl. - - Location of stored logs with additional detail that is related to the event. This - is useful for debugging issues. The URL is valid for 15 minutes. You can also access - fleet creation logs through the GameLift console. - - - - - - Gets and sets the property ResourceId. - - A unique identifier for an event resource, such as a fleet ID. - - - - - - A list of fleet locations where a game session queue can place new game sessions. - You can use a filter to temporarily turn off placements for specific locations. For - queues that have multi-location fleets, you can use a filter configuration allow placement - with some, but not all of these locations. - - - - Filter configurations are part of a GameSessionQueue. - - - - - - Gets and sets the property AllowedLocations. - - A list of locations to allow game session placement in, in the form of AWS Region - codes such as us-west-2. - - - - - - Describes a GameLift fleet of game hosting resources. - - - - Related actions - - - - CreateFleet | DescribeFleetAttributes - - - - - - Gets and sets the property BuildArn. - - The Amazon Resource Name (ARN) - associated with the GameLift build resource that is deployed on instances in this - fleet. In a GameLift build ARN, the resource ID matches the BuildId value. - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build resource that is deployed on instances in this fleet. - - - - - - Gets and sets the property CertificateConfiguration. - - Indicates whether a TLS/SSL certificate was generated for the fleet. - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Description. - - A human-readable description of the fleet. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - In a GameLift fleet ARN, the resource ID matches the FleetId value. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet. - - - - - - Gets and sets the property FleetType. - - The kind of instances, On-Demand or Spot, that this fleet uses. - - - - - - Gets and sets the property InstanceRoleArn. - - A unique identifier for an AWS IAM role that manages access to your AWS services. - With an instance role ARN set, any application that runs on an instance in this fleet - can assume the role, including install scripts, server processes, and daemons (background - processes). Create a role or look up a role's ARN by using the IAM - dashboard in the AWS Management Console. Learn more about using on-box credentials - for your game servers at - Access external resources from a game server. - - - - - - Gets and sets the property InstanceType. - - The EC2 instance type that determines the computing resources of each instance in - the fleet. Instance type defines the CPU, memory, storage, and networking capacity. - See Amazon EC2 Instance Types - for detailed descriptions. - - - - - - Gets and sets the property LogPaths. - - This parameter is no longer used. Game session log paths are now defined using - the GameLift server API ProcessReady() logParameters. See - more information in the Server - API Reference. - - - - - - Gets and sets the property MetricGroups. - - Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, - you can view aggregated metrics for fleets that are in a metric group. A fleet can - be included in only one metric group at a time. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet. Fleet names do not need to be - unique. - - - - - - Gets and sets the property NewGameSessionProtectionPolicy. - - The type of game session protection to set on all new instances that are started in - the fleet. - -
  • - - NoProtection -- The game session can be terminated during a scale-down event. - -
  • - - FullProtection -- If the game session is in an ACTIVE status, - it cannot be terminated during a scale-down event. - -
- - - - - Gets and sets the property OperatingSystem. - - The operating system of the fleet's computing resources. A fleet's operating system - is determined by the OS of the build or script that is deployed on this fleet. - - - - - - Gets and sets the property ResourceCreationLimitPolicy. - - The fleet policy that limits the number of game sessions an individual player can - create over a span of time. - - - - - - Gets and sets the property ScriptArn. - - The Amazon Resource Name (ARN) - associated with the GameLift script resource that is deployed on instances in this - fleet. In a GameLift script ARN, the resource ID matches the ScriptId - value. - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script resource that is deployed on instances - in this fleet. - - - - - - Gets and sets the property ServerLaunchParameters. - - This parameter is no longer used. Server launch parameters are now defined - using the fleet's RuntimeConfiguration parameter. Requests that use this parameter - instead continue to be valid. - - - - - - Gets and sets the property ServerLaunchPath. - - This parameter is no longer used. Server launch paths are now defined using - the fleet's RuntimeConfiguration parameter. Requests that use this parameter - instead continue to be valid. - - - - - - Gets and sets the property Status. - - Current status of the fleet. Possible fleet statuses include the following: - -
  • - - NEW -- A new fleet has been defined and desired instances is set to 1. - -
  • - - DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new - fleet, creating new instances with the game build or Realtime script and starting - server processes. - -
  • - - ACTIVE -- Hosts can now accept game sessions. - -
  • - - ERROR -- An error occurred when downloading, validating, building, or activating - the fleet. - -
  • - - DELETING -- Hosts are responding to a delete fleet request. - -
  • - - TERMINATED -- The fleet no longer exists. - -
- - - - - Gets and sets the property StoppedActions. - - A list of fleet activity that has been suspended using StopFleetActions. This - includes fleet auto-scaling. - - - - - - Gets and sets the property TerminationTime. - - A time stamp indicating when this data object was terminated. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Current resource capacity settings in a specified fleet or location. The location - value might refer to a fleet's remote location or its home Region. - - - - Related actions - - - - DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity - - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet associated with the location. - - - - - - Gets and sets the property InstanceCounts. - - The current instance count and capacity settings for the fleet location. - - - - - - Gets and sets the property InstanceType. - - The EC2 instance type that is used for all instances in a fleet. The instance type - determines the computing resources in use, including CPU, memory, storage, and networking - capacity. See Amazon EC2 Instance - Types for detailed descriptions. - - - - - - Gets and sets the property Location. - - The fleet location for the instance count information, expressed as an AWS Region - code, such as us-west-2. - - - - - - The specified fleet has no available instances to fulfill a CreateGameSession - request. Clients can retry such requests immediately or after a waiting period. - - - - - Constructs a new FleetCapacityExceededException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of FleetCapacityExceededException - - - - - - - Construct instance of FleetCapacityExceededException - - - - - - Construct instance of FleetCapacityExceededException - - - - - - - - - - - Construct instance of FleetCapacityExceededException - - - - - - - - - - Constructs a new instance of the FleetCapacityExceededException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Current resource utilization statistics in a specified fleet or location. The location - value might refer to a fleet's remote location or its home Region. - - - - Related actions - - - - DescribeFleetUtilization | DescribeFleetLocationUtilization - - - - - - Gets and sets the property ActiveGameSessionCount. - - The number of active game sessions that are currently being hosted across all instances - in the fleet location. - - - - - - Gets and sets the property ActiveServerProcessCount. - - The number of server processes in ACTIVE status that are currently running - across all instances in the fleet location. - - - - - - Gets and sets the property CurrentPlayerSessionCount. - - The number of active player sessions that are currently being hosted across all instances - in the fleet location. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet associated with the location. - - - - - - Gets and sets the property Location. - - The fleet location for the fleet utilization information, expressed as an AWS Region - code, such as us-west-2. - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players allowed across all game sessions that are currently - being hosted across all instances in the fleet location. - - - - - - Set of key-value pairs that contain information about a game session. When included - in a game session request, these properties communicate details to be used when setting - up the new game session. For example, a game property might specify a game mode, level, - or map. Game properties are passed to the game server process when initiating a new - game session. For more information, see the - GameLift Developer Guide. - - - - - Gets and sets the property Key. - - The game property identifier. - - - - - - Gets and sets the property Value. - - The game property value. - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - Properties describing a game server that is running on an instance in a GameServerGroup. - - - - - A game server is created by a successful call to RegisterGameServer and - deleted by calling DeregisterGameServer. A game server is claimed to - host a game session by calling ClaimGameServer. - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property ClaimStatus. - - Indicates when an available game server has been reserved for gameplay but has not - yet started hosting a game. Once it is claimed, the game server remains in CLAIMED - status for a maximum of one minute. During this time, game clients connect to the - game server to start the game and trigger the game server to update its utilization - status. After one minute, the game server claim status reverts to null. - - - - - - Gets and sets the property ConnectionInfo. - - The port and IP address that must be used to establish a client connection to the - game server. - - - - - - Gets and sets the property GameServerData. - - A set of custom game server properties, formatted as a single string value. This data - is passed to a game client or service when it requests information on game servers - using ListGameServers or ClaimGameServer. - - - - - - Gets and sets the property GameServerGroupArn. - - The ARN identifier for the game server group where the game server is located. - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server. Game server IDs are developer-defined - and are unique across all game server groups in an AWS account. - - - - - - Gets and sets the property InstanceId. - - The unique identifier for the instance where the game server is running. This ID is - available in the instance metadata. EC2 instance IDs use a 17-character format, for - example: i-1234567890abcdef0. - - - - - - Gets and sets the property LastClaimTime. - - Timestamp that indicates the last time the game server was claimed with a ClaimGameServer - request. The format is a number expressed in Unix time as milliseconds (for example - "1469498468.057"). This value is used to calculate when a claimed game - server's status should revert to null. - - - - - - Gets and sets the property LastHealthCheckTime. - - Timestamp that indicates the last time the game server was updated with health status - using an UpdateGameServer request. The format is a number expressed in Unix - time as milliseconds (for example "1469498468.057"). After game server - registration, this property is only changed when a game server update specifies a - health check value. - - - - - - Gets and sets the property RegistrationTime. - - Timestamp that indicates when the game server was created with a RegisterGameServer - request. The format is a number expressed in Unix time as milliseconds (for example - "1469498468.057"). - - - - - - Gets and sets the property UtilizationStatus. - - Indicates whether the game server is currently available for new games or is busy. - Possible statuses include: - -
  • - - AVAILABLE - The game server is available to be claimed. A game server - that has been claimed remains in this status until it reports game hosting activity. - - -
  • - - UTILIZED - The game server is currently hosting a game session with - players. - -
- - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - Properties that describe a game server group resource. A game server group manages - certain properties related to a corresponding EC2 Auto Scaling group. - - - - A game server group is created by a successful call to CreateGameServerGroup - and deleted by calling DeleteGameServerGroup. Game server group activity - can be temporarily suspended and resumed by calling SuspendGameServerGroup - and ResumeGameServerGroup, respectively. - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property AutoScalingGroupArn. - - A generated unique ID for the EC2 Auto Scaling group that is associated with this - game server group. - - - - - - Gets and sets the property BalancingStrategy. - - Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances - in the game server group. Method options include the following: - -
  • - - SPOT_ONLY - Only Spot Instances are used in the game server group. If - Spot Instances are unavailable or not viable for game hosting, the game server group - provides no hosting capacity until Spot Instances can again be used. Until then, no - new instances are started, and the existing nonviable Spot Instances are terminated - (after current gameplay ends) and are not replaced. - -
  • - - SPOT_PREFERRED - (default value) Spot Instances are used whenever available - in the game server group. If Spot Instances are unavailable, the game server group - continues to provide hosting capacity by falling back to On-Demand Instances. Existing - nonviable Spot Instances are terminated (after current gameplay ends) and are replaced - with new On-Demand Instances. - -
  • - - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server - group. No Spot Instances are used, even when available, while this balancing strategy - is in force. - -
- - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property GameServerGroupArn. - - A generated unique ID for the game server group. - - - - - - Gets and sets the property GameServerGroupName. - - A developer-defined identifier for the game server group. The name is unique for each - Region in each AWS account. - - - - - - Gets and sets the property GameServerProtectionPolicy. - - A flag that indicates whether instances in the game server group are protected from - early termination. Unprotected instances that have active game servers running might - be terminated during a scale-down event, causing players to be dropped from the game. - Protected instances cannot be terminated while there are active game servers running - except in the event of a forced game server group deletion (see ). An exception to - this is with Spot Instances, which can be terminated by AWS regardless of protection - status. - - - - - - Gets and sets the property InstanceDefinitions. - - The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically - scaling instances in the corresponding Auto Scaling group. - - - - - - Gets and sets the property LastUpdatedTime. - - A timestamp that indicates when this game server group was last updated. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) - for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. - - - - - - Gets and sets the property Status. - - The current status of the game server group. Possible statuses include: - -
  • - - NEW - GameLift FleetIQ has validated the CreateGameServerGroup() - request. - -
  • - - ACTIVATING - GameLift FleetIQ is setting up a game server group, which - includes creating an Auto Scaling group in your AWS account. - -
  • - - ACTIVE - The game server group has been successfully created. - -
  • - - DELETE_SCHEDULED - A request to delete the game server group has been - received. - -
  • - - DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() - request and is processing it. GameLift FleetIQ must first complete and release hosts - before it deletes the Auto Scaling group and the game server group. - -
  • - - DELETED - The game server group has been successfully deleted. - -
  • - - ERROR - The asynchronous processes of activating or deleting a game - server group has failed, resulting in an error state. - -
- - - - - Gets and sets the property StatusReason. - - Additional information about the current game server group status. This information - might provide additional insight on groups that are in ERROR status. - - - - - - Gets and sets the property SuspendedActions. - - A list of activities that are currently suspended for this game server group. If this - property is empty, all activities are occurring. - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - Configuration settings for intelligent automatic scaling that uses target tracking. - These settings are used to add an Auto Scaling policy when creating the corresponding - Auto Scaling group with CreateGameServerGroup. After the Auto Scaling group - is created, all updates to Auto Scaling policies, including changing this policy and - adding or removing other policies, is done directly on the Auto Scaling group. - - - - - - Gets and sets the property EstimatedInstanceWarmup. - - Length of time, in seconds, it takes for a new instance to start new game server processes - and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly - with game servers that take a long time to start up, because it avoids prematurely - starting new instances. - - - - - - Gets and sets the property TargetTrackingConfiguration. - - Settings for a target-based scaling policy applied to Auto Scaling group. These settings - are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" - and specifies a target value for the metric. As player usage changes, the policy triggers - to adjust the game server group capacity so that the metric returns to the target - value. - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - Additional properties, including status, that describe an EC2 instance in a game - server group. Instance configurations are set with game server group properties (see - DescribeGameServerGroup and with the EC2 launch template that was used - when creating the game server group. - - - - Retrieve game server instances for a game server group by calling DescribeGameServerInstances. - - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property GameServerGroupArn. - - A generated unique identifier for the game server group that includes the game server - instance. - - - - - - Gets and sets the property GameServerGroupName. - - A developer-defined identifier for the game server group that includes the game server - instance. The name is unique for each Region in each AWS account. - - - - - - Gets and sets the property InstanceId. - - The unique identifier for the instance where the game server is running. This ID is - available in the instance metadata. EC2 instance IDs use a 17-character format, for - example: i-1234567890abcdef0. - - - - - - Gets and sets the property InstanceStatus. - - Current status of the game server instance. - -
  • - - ACTIVE -- The instance is viable for hosting game servers. - -
  • - - DRAINING -- The instance is not viable for hosting game servers. Existing - game servers are in the process of ending, and new game servers are not started on - this instance unless no other resources are available. When the instance is put in - DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED - game servers, it will be terminated in favor of the new instance. - -
  • - - SPOT_TERMINATING -- The instance is in the process of shutting down due to - a Spot instance interruption. No new game servers are started on this instance. - -
- - - - - Properties describing a game session. - - - - A game session in ACTIVE status can host players. When a game session ends, its status - is set to TERMINATED. - - - - Once the session ends, the game session object is retained for 30 days. This means - you can reuse idempotency token values after this time. Game session logs are retained - for 14 days. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property CreatorId. - - A unique identifier for a player. This ID is used to enforce a resource protection - policy (if one exists), that limits the number of game sessions a player can create. - - - - - - Gets and sets the property CurrentPlayerSessionCount. - - Number of players currently in the game session. - - - - - - Gets and sets the property DnsName. - - The DNS identifier assigned to the instance that is running the game session. Values - have the following format: - -
  • - - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. - -
  • - - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. - (See Amazon - EC2 Instance IP Addressing.) - -
- - When connecting to a game session that is running on a TLS-enabled fleet, you must - use the DNS name, not the IP address. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - associated with the GameLift fleet that this game session is running on. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that the game session is running on. - - - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session. You can search for active game sessions based - on this custom data with SearchGameSessions. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session. - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session. A game session ARN has the following format: - arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID - string or idempotency token>. - - - - - - Gets and sets the property IpAddress. - - The IP address of the game session. To connect to a GameLift game server, an app needs - both the IP address and port number. - - - - - - Gets and sets the property Location. - - The fleet location where the game session is running. This value might specify the - fleet's home Region or a remote location. Location is expressed as an AWS Region code - such as us-west-2. - - - - - - Gets and sets the property MatchmakerData. - - Information about the matchmaking process that was used to create the game session. - It is in JSON syntax, formatted as a string. In addition the matchmaking configuration - used, it contains data on all players assigned to the match, including player attributes - and team assignments. For more details on matchmaker data, see Match - Data. Matchmaker data is useful when requesting match backfills, and is updated - whenever new players are added during a successful backfill (see StartMatchBackfill). - - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players that can be connected simultaneously to the game session. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a game session. Session names do not need - to be unique. - - - - - - Gets and sets the property PlayerSessionCreationPolicy. - - Indicates whether or not the game session is accepting new players. - - - - - - Gets and sets the property Port. - - The port number for the game session. To connect to a GameLift game server, an app - needs both the IP address and port number. - - - - - - Gets and sets the property Status. - - Current status of the game session. A game session must have an ACTIVE - status to have player sessions. - - - - - - Gets and sets the property StatusReason. - - Provides additional information about game session status. INTERRUPTED - indicates that the game session was hosted on a spot instance that was reclaimed, - causing the active game session to be terminated. - - - - - - Gets and sets the property TerminationTime. - - A time stamp indicating when this data object was terminated. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Connection information for a new game session that is created in response to a StartMatchmaking - request. Once a match is made, the FlexMatch engine creates a new game session for - it. This information, including the game session endpoint and player sessions for - each player in the original matchmaking request, is added to the MatchmakingTicket, - which can be retrieved by calling DescribeMatchmaking. - - - - - Gets and sets the property DnsName. - - The DNS identifier assigned to the instance that is running the game session. Values - have the following format: - -
  • - - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. - -
  • - - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. - (See Amazon - EC2 Instance IP Addressing.) - -
- - When connecting to a game session that is running on a TLS-enabled fleet, you must - use the DNS name, not the IP address. - - - - - - Gets and sets the property GameSessionArn. - - A unique identifier for the game session. Use the game session ID. - - - - - - Gets and sets the property IpAddress. - - The IP address of the game session. To connect to a GameLift game server, an app needs - both the IP address and port number. - - - - - - Gets and sets the property MatchedPlayerSessions. - - A collection of player session IDs, one for each player ID that was included in the - original matchmaking request. - - - - - - Gets and sets the property Port. - - The port number for the game session. To connect to a GameLift game server, an app - needs both the IP address and port number. - - - - - - A game session's properties plus the protection policy currently in force. - - - - - Gets and sets the property GameSession. - - Object that describes a game session. - - - - - - Gets and sets the property ProtectionPolicy. - - Current status of protection for the game session. - -
  • - - NoProtection -- The game session can be terminated during a scale-down event. - -
  • - - FullProtection -- If the game session is in an ACTIVE status, - it cannot be terminated during a scale-down event. - -
- - - - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - - - Constructs a new GameSessionFullException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of GameSessionFullException - - - - - - - Construct instance of GameSessionFullException - - - - - - Construct instance of GameSessionFullException - - - - - - - - - - - Construct instance of GameSessionFullException - - - - - - - - - - Constructs a new instance of the GameSessionFullException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Object that describes a StartGameSessionPlacement request. This object includes - the full details of the original request plus the current status and start/end time - stamps. - - - - Game session placement-related operations include: - - - - - - - Gets and sets the property DnsName. - - The DNS identifier assigned to the instance that is running the game session. Values - have the following format: - -
  • - - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. - -
  • - - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. - (See Amazon - EC2 Instance IP Addressing.) - -
- - When connecting to a game session that is running on a TLS-enabled fleet, you must - use the DNS name, not the IP address. - - - - - - Gets and sets the property EndTime. - - Time stamp indicating when this request was completed, canceled, or timed out. - - - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session (see Start - a Game Session). - - - - - - Gets and sets the property GameSessionArn. - - Identifier for the game session created by this placement request. This value is set - once the new game session is placed (placement status is FULFILLED). - This identifier is unique across all Regions. You can use this value as a GameSessionId - value as needed. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session (see Start - a Game Session). - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session. This value is set once the new game session - is placed (placement status is FULFILLED). - - - - - - Gets and sets the property GameSessionName. - - A descriptive label that is associated with a game session. Session names do not need - to be unique. - - - - - - Gets and sets the property GameSessionQueueName. - - A descriptive label that is associated with game session queue. Queue names must be - unique within each Region. - - - - - - Gets and sets the property GameSessionRegion. - - Name of the Region where the game session created by this placement request is running. - This value is set once the new game session is placed (placement status is FULFILLED). - - - - - - Gets and sets the property IpAddress. - - The IP address of the game session. To connect to a GameLift game server, an app needs - both the IP address and port number. This value is set once the new game session is - placed (placement status is FULFILLED). - - - - - - Gets and sets the property MatchmakerData. - - Information on the matchmaking process for this game. Data is in JSON syntax, formatted - as a string. It identifies the matchmaking configuration used to create the match, - and contains data on all players assigned to the match, including player attributes - and team assignments. For more details on matchmaker data, see Match - Data. - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players that can be connected simultaneously to the game session. - - - - - - Gets and sets the property PlacedPlayerSessions. - - A collection of information on player sessions created in response to the game session - placement request. These player sessions are created only once a new game session - is successfully placed (placement status is FULFILLED). This information - includes the player ID (as provided in the placement request) and the corresponding - player session ID. Retrieve full player sessions by calling DescribePlayerSessions - with the player session ID. - - - - - - Gets and sets the property PlacementId. - - A unique identifier for a game session placement. - - - - - - Gets and sets the property PlayerLatencies. - - A set of values, expressed in milliseconds, that indicates the amount of latency that - a player experiences when connected to AWS Regions. - - - - - - Gets and sets the property Port. - - The port number for the game session. To connect to a GameLift game server, an app - needs both the IP address and port number. This value is set once the new game session - is placed (placement status is FULFILLED). - - - - - - Gets and sets the property StartTime. - - Time stamp indicating when this request was placed in the queue. Format is a number - expressed in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Status. - - Current status of the game session placement request. - -
  • - - PENDING -- The placement request is currently in the queue waiting to be processed. - -
  • - - FULFILLED -- A new game session and player sessions (if requested) have been - successfully created. Values for GameSessionArn and GameSessionRegion - are available. - -
  • - - CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement. - -
  • - - TIMED_OUT -- A new game session was not successfully created before the time - limit expired. You can resubmit the placement request as needed. - -
  • - - FAILED -- GameLift is not able to complete the process of placing the game - session. Common reasons are the game session terminated before the placement process - was completed, or an unexpected internal error. - -
- - - - - Configuration for a game session placement mechanism that processes requests for new - game sessions. A queue can be used on its own or as part of a matchmaking solution. - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - - - - - - - Gets and sets the property CustomEventData. - - Information that is added to all events that are related to this game session queue. - - - - - - - Gets and sets the property Destinations. - - A list of fleets and/or fleet aliases that can be used to fulfill game session placement - requests in the queue. Destinations are identified by either a fleet ARN or a fleet - alias ARN, and are listed in order of placement preference. - - - - - - Gets and sets the property FilterConfiguration. - - A list of locations where a queue is allowed to place new game sessions. Locations - are specified in the form of AWS Region codes, such as us-west-2. If - this parameter is not set, game sessions can be placed in any queue location. - - - - - - Gets and sets the property GameSessionQueueArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift game session queue resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue - name>. In a GameLift game session queue ARN, the resource ID matches the - Name value. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with game session queue. Queue names must be - unique within each Region. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive game session placement notifications. See - - Setting up notifications for game session placement. - - - - - - Gets and sets the property PlayerLatencyPolicies. - - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver - low latency for most players in a game session. These policies ensure that no individual - player can be placed into a game with unreasonably high latency. Use multiple policies - to gradually relax latency requirements a step at a time. Multiple policies are applied - based on their maximum allowed latency, starting with the lowest value. - - - - - - Gets and sets the property PriorityConfiguration. - - Custom settings to use when prioritizing destinations and locations for game session - placements. This configuration replaces the FleetIQ default prioritization process. - Priority types that are not explicitly named will be automatically applied at the - end of the prioritization process. - - - - - - Gets and sets the property TimeoutInSeconds. - - The maximum time, in seconds, that a new game session placement request remains in - the queue. When a request exceeds this time, the game session placement changes to - a TIMED_OUT status. - - - - - - A fleet or alias designated in a game session queue. Queues fulfill requests for new - game sessions by placing a new game session on any of the queue's destinations. - - - - Destinations are part of a GameSessionQueue. - - - - - - Gets and sets the property DestinationArn. - - The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which - include a fleet ID or alias ID and a Region name, provide a unique identifier across - all Regions. - - - - - - Container for the parameters to the GetGameSessionLogUrl operation. - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to get logs for. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property PreSignedUrl. - - Location of the requested game session logs, available for download. This URL is valid - for 15 minutes, after which S3 will reject any download request using this URL. You - can request a new URL any time within the 14-day period that the logs are retained. - - - - - - Container for the parameters to the GetInstanceAccess operation. - Requests remote access to a fleet instance. Remote access is useful for debugging, - gathering benchmarking data, or observing activity in real time. - - - - To remotely access an instance, you need credentials that match the operating system - of the instance. For a Windows instance, GameLift returns a user name and password - as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - returns a user name and RSA private key, also as strings, for use with an SSH client. - The private key must be saved in the proper format to a .pem file before - using. If you're making this request using the AWS CLI, saving the secret can be handled - as part of the GetInstanceAccess request, as shown in one of the examples - for this operation. - - - - To request access to a specific instance, specify the IDs of both the instance and - the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. - If successful, an InstanceAccess object is returned that contains the instance's - IP address and a set of credentials. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that contains the instance you want access to. You - can use either the fleet ID or ARN value. The fleet can be in any of the following - statuses: ACTIVATING, ACTIVE, or ERROR. Fleets - with an ERROR status may be accessible for a short time before they are - deleted. - - - - - - Gets and sets the property InstanceId. - - A unique identifier for the instance you want to get access to. You can access an - instance in any status. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property InstanceAccess. - - The connection information for a fleet instance, including IP address and access credentials. - - - - - - A game session with this custom ID string already exists in this fleet. Resolve this - conflict before retrying this request. - - - - - Constructs a new IdempotentParameterMismatchException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of IdempotentParameterMismatchException - - - - - - - Construct instance of IdempotentParameterMismatchException - - - - - - Construct instance of IdempotentParameterMismatchException - - - - - - - - - - - Construct instance of IdempotentParameterMismatchException - - - - - - - - - - Constructs a new instance of the IdempotentParameterMismatchException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Represents an EC2 instance of virtual computing resources that hosts one or more game - servers. In GameLift, a fleet can contain zero or more instances. - - - - Related actions - - - - DescribeInstances - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property DnsName. - - The DNS identifier assigned to the instance that is running the game session. Values - have the following format: - -
  • - - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. - -
  • - - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. - (See Amazon - EC2 Instance IP Addressing.) - -
- - When connecting to a game session that is running on a TLS-enabled fleet, you must - use the DNS name, not the IP address. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that the instance is in. - - - - - - Gets and sets the property InstanceId. - - A unique identifier for the instance. - - - - - - Gets and sets the property IpAddress. - - IP address that is assigned to the instance. - - - - - - Gets and sets the property Location. - - The fleet location of the instance, expressed as an AWS Region code, such as us-west-2. - - - - - - - Gets and sets the property OperatingSystem. - - Operating system that is running on this instance. - - - - - - Gets and sets the property Status. - - Current status of the instance. Possible statuses include the following: - -
  • - - PENDING -- The instance is in the process of being created and launching server - processes as defined in the fleet's run-time configuration. - -
  • - - ACTIVE -- The instance has been successfully created and at least one server - process has successfully launched and reported back to GameLift that it is ready to - host a game session. The instance is now considered ready to host game sessions. - -
  • - - TERMINATING -- The instance is in the process of shutting down. This may happen - to reduce capacity during a scaling down event or to recycle resources in the event - of a problem. - -
- - - - - Gets and sets the property Type. - - EC2 instance type that defines the computing resources of this instance. - - - - - - Information required to remotely connect to a fleet instance. Access is requested - by calling GetInstanceAccess. - - - - - Gets and sets the property Credentials. - - Credentials required to access the instance. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet containing the instance being accessed. - - - - - - Gets and sets the property InstanceId. - - A unique identifier for the instance being accessed. - - - - - - Gets and sets the property IpAddress. - - IP address that is assigned to the instance. - - - - - - Gets and sets the property OperatingSystem. - - Operating system that is running on the instance. - - - - - - Set of credentials required to remotely access a fleet instance. Access credentials - are requested by calling GetInstanceAccess and returned in an InstanceAccess - object. - - - - - Gets and sets the property Secret. - - Secret string. For Windows instances, the secret is a password for use with Windows - Remote Desktop. For Linux instances, it is a private key (which must be saved as a - .pem file) for use with SSH. - - - - - - Gets and sets the property UserName. - - User login string. - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - An allowed instance type for a GameServerGroup. All game server groups must - have at least two instance types defined for it. GameLift FleetIQ periodically evaluates - each defined instance type for viability. It then updates the Auto Scaling group with - the list of viable instance types. - - - - - - Gets and sets the property InstanceType. - - An EC2 instance type designation. - - - - - - Gets and sets the property WeightedCapacity. - - Instance weighting that indicates how much this instance type contributes to the total - capacity of a game server group. Instance weights are used by GameLift FleetIQ to - calculate the instance type's cost per unit hour and better identify the most cost-effective - options. For detailed information on weighting instance capacity, see Instance - Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1". - - - - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - - - Constructs a new InternalServiceException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InternalServiceException - - - - - - - Construct instance of InternalServiceException - - - - - - Construct instance of InternalServiceException - - - - - - - - - - - Construct instance of InternalServiceException - - - - - - - - - - Constructs a new instance of the InternalServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - AcceptMatch Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AcceptMatch operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Alias Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - AttributeValue Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for AttributeValue Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Build Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - CertificateConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for CertificateConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - ClaimGameServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ClaimGameServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ConflictException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - CreateAlias Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateAlias operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateBuild Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateBuild operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateFleetLocations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateFleetLocations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateFleet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateFleet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateGameSessionQueue Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateGameSessionQueue operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateGameSession Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateGameSession operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateMatchmakingConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateMatchmakingConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateMatchmakingRuleSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateMatchmakingRuleSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreatePlayerSession Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreatePlayerSession operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreatePlayerSessions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreatePlayerSessions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateScript Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateScript operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateVpcPeeringAuthorization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateVpcPeeringAuthorization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - CreateVpcPeeringConnection Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for CreateVpcPeeringConnection operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Credentials Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - DeleteAlias Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteAlias operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteBuild Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteBuild operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteFleetLocations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteFleetLocations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteFleet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteFleet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteGameSessionQueue Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteGameSessionQueue operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteMatchmakingConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteMatchmakingConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteMatchmakingRuleSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteMatchmakingRuleSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteScalingPolicy Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteScalingPolicy operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteScript Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteScript operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteVpcPeeringAuthorization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteVpcPeeringAuthorization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeleteVpcPeeringConnection Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeleteVpcPeeringConnection operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DeregisterGameServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DeregisterGameServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeAlias Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeAlias operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeBuild Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeBuild operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeEC2InstanceLimits Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeEC2InstanceLimits operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetCapacity Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetCapacity operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetEvents Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetEvents operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetLocationAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetLocationAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetLocationCapacity Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetLocationCapacity operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetLocationUtilization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetLocationUtilization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetPortSettings Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetPortSettings operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeFleetUtilization Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeFleetUtilization operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameServerInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameServerInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameSessionDetails Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameSessionDetails operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameSessionPlacement Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameSessionPlacement operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameSessionQueues Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameSessionQueues operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeGameSessions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeGameSessions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeInstances Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeInstances operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeMatchmakingConfigurations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeMatchmakingConfigurations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeMatchmaking Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeMatchmaking operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeMatchmakingRuleSets Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeMatchmakingRuleSets operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribePlayerSessions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribePlayerSessions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeRuntimeConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeRuntimeConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeScalingPolicies Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeScalingPolicies operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeScript Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeScript operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeVpcPeeringAuthorizations Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeVpcPeeringAuthorizations operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DescribeVpcPeeringConnections Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DescribeVpcPeeringConnections operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - DesiredPlayerSession Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for EC2InstanceCounts Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for EC2InstanceLimit Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Event Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - FilterConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for FilterConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for FleetAttributes Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for FleetCapacityExceededException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for FleetCapacity Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for FleetUtilization Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GameProperty Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for GameProperty Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GameServerGroupAutoScalingPolicy Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for GameServerGroup Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameServerInstance Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameServer Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSessionConnectionInfo Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSessionDetail Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSessionFullException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSessionPlacement Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GameSessionQueueDestination Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for GameSessionQueueDestination Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSessionQueue Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GameSession Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetGameSessionLogUrl Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetGameSessionLogUrl operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetInstanceAccess Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetInstanceAccess operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for IdempotentParameterMismatchException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InstanceAccess Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InstanceCredentials Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - InstanceDefinition Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for InstanceDefinition Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Instance Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InternalServiceException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidFleetStatusException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidGameSessionStatusException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidRequestException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - IpPermission Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for IpPermission Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - LaunchTemplateSpecification Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for LimitExceededException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - ListAliases Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListAliases operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListBuilds Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListBuilds operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListFleets Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListFleets operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListGameServerGroups Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListGameServerGroups operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListGameServers Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListGameServers operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListScripts Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListScripts operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ListTagsForResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ListTagsForResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for LocationAttributes Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - LocationConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for LocationState Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MatchedPlayerSession Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MatchmakingConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MatchmakingRuleSet Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MatchmakingTicket Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for NotFoundException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for OutOfCapacityException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PlacedPlayerSession Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PlayerLatency Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - PlayerLatencyPolicy Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for PlayerLatencyPolicy Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PlayerLatency Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Player Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for PlayerSession Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Player Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PriorityConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for PriorityConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutScalingPolicy Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PutScalingPolicy operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RegisterGameServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RegisterGameServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RequestUploadCredentials Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RequestUploadCredentials operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ResolveAlias Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResolveAlias operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ResourceCreationLimitPolicy Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for ResourceCreationLimitPolicy Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - ResumeGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ResumeGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - RoutingStrategy Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for RoutingStrategy Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - RuntimeConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for RuntimeConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - S3Location Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for S3Location Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ScalingPolicy Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Script Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - SearchGameSessions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SearchGameSessions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ServerProcess Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for ServerProcess Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - StartFleetActions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StartFleetActions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StartGameSessionPlacement Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StartGameSessionPlacement operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StartMatchBackfill Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StartMatchBackfill operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StartMatchmaking Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StartMatchmaking operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StopFleetActions Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StopFleetActions operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StopGameSessionPlacement Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StopGameSessionPlacement operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - StopMatchmaking Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for StopMatchmaking operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - SuspendGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for SuspendGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TaggingFailedException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Tag Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - TagResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for TagResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Tag Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - TargetConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for TargetConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - TargetTrackingConfiguration Marshaller - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Singleton Marshaller. - - - - - Response Unmarshaller for TerminalRoutingStrategyException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnauthorizedException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UnsupportedRegionException Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - - Gets the singleton. - - - - - UntagResource Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UntagResource operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateAlias Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateAlias operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateBuild Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateBuild operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateFleetAttributes Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateFleetAttributes operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateFleetCapacity Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateFleetCapacity operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateFleetPortSettings Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateFleetPortSettings operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateGameServerGroup Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateGameServerGroup operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateGameServer Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateGameServer operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateGameSessionQueue Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateGameSessionQueue operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateGameSession Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateGameSession operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateMatchmakingConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateMatchmakingConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateRuntimeConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateRuntimeConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - UpdateScript Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for UpdateScript operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - ValidateMatchmakingRuleSet Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ValidateMatchmakingRuleSet operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for VpcPeeringAuthorization Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for VpcPeeringConnectionStatus Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for VpcPeeringConnection Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - - - Constructs a new InvalidFleetStatusException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidFleetStatusException - - - - - - - Construct instance of InvalidFleetStatusException - - - - - - Construct instance of InvalidFleetStatusException - - - - - - - - - - - Construct instance of InvalidFleetStatusException - - - - - - - - - - Constructs a new instance of the InvalidFleetStatusException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - - - Constructs a new InvalidGameSessionStatusException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidGameSessionStatusException - - - - - - - Construct instance of InvalidGameSessionStatusException - - - - - - Construct instance of InvalidGameSessionStatusException - - - - - - - - - - - Construct instance of InvalidGameSessionStatusException - - - - - - - - - - Constructs a new instance of the InvalidGameSessionStatusException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - - - Constructs a new InvalidRequestException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidRequestException - - - - - - - Construct instance of InvalidRequestException - - - - - - Construct instance of InvalidRequestException - - - - - - - - - - - Construct instance of InvalidRequestException - - - - - - - - - - Constructs a new instance of the InvalidRequestException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A range of IP addresses and port settings that allow inbound traffic to connect to - server processes on an instance in a fleet. New game sessions are assigned an IP address/port - number combination, which must fall into the fleet's allowed ranges. Fleets with custom - game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift - automatically opens two port ranges, one for TCP messaging and one for UDP. - - - - Related actions - - - - DescribeFleetPortSettings - - - - - - Gets and sets the property FromPort. - - A starting value for a range of allowed port numbers. - - - - - - Gets and sets the property IpRange. - - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: - "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet - mask]". - - - - - - Gets and sets the property Protocol. - - The network communication protocol used by the fleet. - - - - - - Gets and sets the property ToPort. - - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. - This value must be higher than FromPort. - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - An EC2 launch template that contains configuration settings and game server code to - be deployed to all instances in a game server group. The launch template is specified - when creating a new game server group with CreateGameServerGroup. - - - - - - Gets and sets the property LaunchTemplateId. - - A unique identifier for an existing EC2 launch template. - - - - - - Gets and sets the property LaunchTemplateName. - - A readable identifier for an existing EC2 launch template. - - - - - - Gets and sets the property Version. - - The version of the EC2 launch template to use. If no version is specified, the default - version will be used. With Amazon EC2, you can specify a default version for a launch - template. If none is set, the default is the first version created. - - - - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - - - Constructs a new LimitExceededException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of LimitExceededException - - - - - - - Construct instance of LimitExceededException - - - - - - Construct instance of LimitExceededException - - - - - - - - - - - Construct instance of LimitExceededException - - - - - - - - - - Constructs a new instance of the LimitExceededException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the ListAliases operation. - Retrieves all aliases for this AWS account. You can filter the result set by alias - name and/or routing strategy type. Use the pagination parameters to retrieve results - in sequential pages. - - - - Returned aliases are not listed in any particular order. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with an alias. Alias names do not need to be - unique. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property RoutingStrategyType. - - The routing type to filter results on. Use this parameter to retrieve only aliases - with a certain routing type. To retrieve all aliases, leave this parameter empty. - - - - Possible routing types include the following: - -
  • - - SIMPLE -- The alias resolves to one specific fleet. Use this type when routing - to active fleets. - -
  • - - TERMINAL -- The alias does not resolve to a fleet but instead can be used - to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException - with the RoutingStrategy message embedded. - -
- - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Aliases. - - A collection of alias resources that match the request parameters. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the ListBuilds operation. - Retrieves build resources for all builds associated with the AWS account in use. You - can limit results to builds that are in a specific status by using the Status - parameter. Use the pagination parameters to retrieve results in a set of sequential - pages. - - - - Build resources are not listed in any particular order. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property Status. - - Build status to filter results by. To retrieve all builds, leave this parameter empty. - - - - Possible build statuses include the following: - -
  • - - INITIALIZED -- A new build has been defined, but no files have been uploaded. - You cannot create fleets for builds that are in this status. When a build is successfully - created, the build status is set to this value. - -
  • - - READY -- The game build has been successfully uploaded. You can now create - new fleets for this build. - -
  • - - FAILED -- The game build upload failed. You cannot create new fleets for this - build. - -
- - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Builds. - - A collection of build resources that match the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the ListFleets operation. - Retrieves a collection of fleet resources in an AWS Region. You can call this operation - to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - specify a Region in your request. You can filter the result set to find only those - fleets that are deployed with a specific build or script. For fleets that have multiple - locations, this operation retrieves fleets based on their home Region only. - - - - This operation can be used in the following ways: - -
  • - - To get a list of all fleets in a Region, don't provide a build or script identifier. - - -
  • - - To get a list of all fleets where a specific custom game build is deployed, provide - the build ID. - -
  • - - To get a list of all Realtime Servers fleets with a specific configuration script, - provide the script ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a list of fleet IDs that match the request parameters is returned. - A NextToken value is also returned if there are more result pages to retrieve. - - - - Fleet resources are not listed in a particular order. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build to request fleets for. Use this parameter to return - only fleets using a specified build. Use either the build ID or ARN value. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script to request fleets for. Use this parameter - to return only fleets using a specified script. Use either the script ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetIds. - - A set of fleet IDs that match the list request. You can retrieve additional information - about all returned fleets by passing this result set to a DescribeFleetAttributes, - DescribeFleetCapacity, or DescribeFleetUtilization call. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the ListGameServerGroups operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers groups that exist in the current AWS account - for the selected Region. Use the pagination parameters to retrieve results in a set - of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - This is the response object from the ListGameServerGroups operation. - - - - - Gets and sets the property GameServerGroups. - - A collection of game server group objects that match the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the ListGameServers operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers that are currently active in a specified - game server group. You can opt to sort the list by game server age. Use the pagination - parameters to retrieve results in a set of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - An identifier for the game server group to retrieve a list of game servers from. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property SortOrder. - - Indicates how to sort the returned data based on game server registration timestamp. - Use ASCENDING to retrieve oldest game servers first, or use DESCENDING - to retrieve newest game servers first. If this parameter is left empty, game servers - are returned in no particular order. - - - - - - This is the response object from the ListGameServers operation. - - - - - Gets and sets the property GameServers. - - A collection of game server objects that match the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Container for the parameters to the ListScripts operation. - Retrieves script records for all Realtime scripts that are associated with the AWS - account in use. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - This is the response object from the ListScripts operation. - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - Gets and sets the property Scripts. - - A set of properties describing the requested script. - - - - - - Container for the parameters to the ListTagsForResource operation. - Retrieves all tags that are assigned to a GameLift resource. Resource tags are used - to organize AWS resources for a range of purposes. This operation handles the permissions - necessary to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To list tags for a resource, specify the unique ARN value for the resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - - - - Gets and sets the property ResourceARN. - - The Amazon Resource Name (ARN) - that is assigned to and uniquely identifies the GameLift resource that you want to - retrieve tags for. GameLift resource ARNs are included in the data object for the - resource, which can be retrieved by calling a List or Describe operation for the resource - type. - - - - - - This is the response object from the ListTagsForResource operation. - - - - - Gets and sets the property Tags. - - The collection of tags that have been assigned to the specified resource. - - - - - - Represents a location in a multi-location fleet. - - - - Related actions - - - - DescribeFleetLocationAttributes - - - - - - Gets and sets the property LocationState. - - A fleet location and its current life-cycle state. - - - - - - Gets and sets the property StoppedActions. - - A list of fleet actions that have been suspended in the fleet location. - - - - - - Gets and sets the property UpdateStatus. - - The status of fleet activity updates to the location. The status PENDING_UPDATE - indicates that StopFleetActions or StartFleetActions has been requested - but the update has not yet been completed for the location. - - - - - - A remote location where a multi-location fleet can deploy EC2 instances for game hosting. - - - - - Related actions - - - - CreateFleet - - - - - - Gets and sets the property Location. - - An AWS Region code, such as us-west-2. - - - - - - A fleet location and its life-cycle state. A location state object might be used to - describe a fleet's remote location or home Region. Life-cycle state tracks the progress - of launching the first instance in a new location and preparing it for game hosting, - and then removing all instances and deleting the location from the fleet. - - - - Related actions - - - - CreateFleet | CreateFleetLocations | DeleteFleetLocations - - - - - - Gets and sets the property Location. - - The fleet location, expressed as an AWS Region code such as us-west-2. - - - - - - - Gets and sets the property Status. - - The life-cycle status of a fleet location. - - - - - - Represents a new player session that is created as a result of a successful FlexMatch - match. A successful match automatically creates new player sessions for every player - ID in the original matchmaking request. - - - - When players connect to the match's game session, they must include both player ID - and player session ID in order to claim their assigned player slot. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player - - - - - - Gets and sets the property PlayerSessionId. - - A unique identifier for a player session - - - - - - Guidelines for use with FlexMatch to match players into games. All matchmaking requests - must specify a matchmaking configuration. - - - - - Gets and sets the property AcceptanceRequired. - - A flag that indicates whether a match that was created with this configuration must - be accepted by the matched players. To require acceptance, set to TRUE. When this - option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE - to indicate when a completed potential match is waiting for player acceptance. - - - - - - Gets and sets the property AcceptanceTimeoutSeconds. - - The length of time (in seconds) to wait for players to accept a proposed match, if - acceptance is required. If any player rejects the match or fails to accept before - the timeout, the ticket continues to look for an acceptable match. - - - - - - Gets and sets the property AdditionalPlayerCount. - - The number of player slots in a match to keep open for future players. For example, - if the configuration's rule set specifies a match for a single 12-person team, and - the additional player count is set to 2, only 10 players are selected for the match. - This parameter is not used when FlexMatchMode is set to STANDALONE. - - - - - - Gets and sets the property BackfillMode. - - The method used to backfill game sessions created with this matchmaking configuration. - MANUAL indicates that the game makes backfill requests or does not use the match backfill - feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests - whenever a game session has one or more open slots. Learn more about manual and automatic - backfill in Backfill - existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property ConfigurationArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift matchmaking configuration resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking - configuration name>. In a GameLift configuration ARN, the resource ID matches - the Name value. - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property CustomEventData. - - Information to attach to all events related to the matchmaking configuration. - - - - - - Gets and sets the property Description. - - A descriptive label that is associated with matchmaking configuration. - - - - - - Gets and sets the property FlexMatchMode. - - Indicates whether this matchmaking configuration is being used with GameLift hosting - or as a standalone matchmaking solution. - -
  • - - STANDALONE - FlexMatch forms matches and returns match information, including - players and team assignments, in a - MatchmakingSucceeded event. - -
  • - - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue - to start a game session for the match. - -
- - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used when FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used when FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionQueueArns. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift game session queue resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue - name>. Queues can be located in any Region. Queues are used to start new - GameLift-hosted game sessions for matches that are created with this matchmaking configuration. - This property is not set when FlexMatchMode is set to STANDALONE. - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking configuration. This name is used to identify - the configuration associated with a matchmaking request or ticket. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive matchmaking notifications. - - - - - - Gets and sets the property RequestTimeoutSeconds. - - The maximum duration, in seconds, that a matchmaking ticket can remain in process - before timing out. Requests that fail due to timing out can be resubmitted as needed. - - - - - - Gets and sets the property RuleSetArn. - - The Amazon Resource Name (ARN) - associated with the GameLift matchmaking rule set resource that this configuration - uses. - - - - - - Gets and sets the property RuleSetName. - - A unique identifier for the matchmaking rule set to use with this configuration. A - matchmaking configuration can only use rule sets that are defined in the same Region. - - - - - - Set of rule statements, used with FlexMatch, that determine how to build your player - matches. Each rule set describes a type of group to be created and defines the parameters - for acceptable player matches. Rule sets are used in MatchmakingConfiguration - objects. - - - - A rule set may define the following elements for a match. For detailed information - and examples showing how to construct a rule set, see Build - a FlexMatch rule set. - -
  • - - Teams -- Required. A rule set must define one or multiple teams for the match and - set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match - that requires all eight slots to be filled. - -
  • - - Player attributes -- Optional. These attributes specify a set of player characteristics - to evaluate when looking for a match. Matchmaking requests that use a rule set with - player attributes must provide the corresponding attribute values. For example, an - attribute might specify a player's skill or level. - -
  • - - Rules -- Optional. Rules define how to evaluate potential players for a match based - on player attributes. A rule might specify minimum requirements for individual players, - teams, or entire matches. For example, a rule might require each player to meet a - certain skill level, each team to have at least one player in a certain role, or the - match to have a minimum average skill level. or may describe an entire group--such - as all teams must be evenly matched or have at least one player in a certain role. - - -
  • - - Expansions -- Optional. Expansions allow you to relax the rules after a period of - time when no acceptable matches are found. This feature lets you balance getting players - into games in a reasonable amount of time instead of making them wait indefinitely - for the best possible match. For example, you might use an expansion to increase the - maximum skill variance between players after 30 seconds. - -
- - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property RuleSetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift matchmaking rule set resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset - name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName - value. - - - - - - Gets and sets the property RuleSetBody. - - A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed - in JSON, but most elements support a description field. - - - - - - Gets and sets the property RuleSetName. - - A unique identifier for the matchmaking rule set - - - - - - Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely - identified by a ticket ID, supplied by the requester, when creating a matchmaking - request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking - with the ticket ID. - - - - - Gets and sets the property ConfigurationArn. - - The Amazon Resource Name (ARN) - associated with the GameLift matchmaking configuration resource that is used with - this ticket. - - - - - - Gets and sets the property ConfigurationName. - - Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking - configurations determine how players are grouped into a match and how a new game session - is created for the match. - - - - - - Gets and sets the property EndTime. - - Time stamp indicating when this matchmaking request stopped being processed due to - success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds - (for example "1469498468.057"). - - - - - - Gets and sets the property EstimatedWaitTime. - - Average amount of time (in seconds) that players are currently waiting for a match. - If there is not enough recent data, this property may be empty. - - - - - - Gets and sets the property GameSessionConnectionInfo. - - Identifier and connection information of the game session created for the match. This - information is added to the ticket only after the matchmaking request has been successfully - completed. This parameter is not set when FlexMatch is being used without GameLift - hosting. - - - - - - Gets and sets the property Players. - - A set of Player objects, each representing a player to find matches for. - Players are identified by a unique player ID and may include latency data for use - during matchmaking. If the ticket is in status COMPLETED, the Player - objects include the team the players were assigned to in the resulting match. - - - - - - Gets and sets the property StartTime. - - Time stamp indicating when this matchmaking request was received. Format is a number - expressed in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Status. - - Current status of the matchmaking request. - -
  • - - QUEUED -- The matchmaking request has been received and is currently waiting - to be processed. - -
  • - - SEARCHING -- The matchmaking request is currently being processed. - -
  • - - REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept - the match (see AcceptMatch). This status is used only with requests that use - a matchmaking configuration with a player acceptance requirement. - -
  • - - PLACING -- The FlexMatch engine has matched players and is in the process - of placing a new game session for the match. - -
  • - - COMPLETED -- Players have been matched and a game session is ready to host - the players. A ticket in this state contains the necessary connection information - for players. - -
  • - - FAILED -- The matchmaking request was not completed. - -
  • - - CANCELLED -- The matchmaking request was canceled. This may be the result - of a call to StopMatchmaking or a proposed match that one or more players failed - to accept. - -
  • - - TIMED_OUT -- The matchmaking request was not successful within the duration - specified in the matchmaking configuration. - -
- - Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, - TIMED_OUT) can be resubmitted as new requests with new ticket IDs. - - - - - - - Gets and sets the property StatusMessage. - - Additional information about the current status. - - - - - - Gets and sets the property StatusReason. - - Code to explain the current status. For example, a status reason may indicate when - a ticket has returned to SEARCHING status after a proposed match fails - to receive player acceptances. - - - - - - Gets and sets the property TicketId. - - A unique identifier for a matchmaking ticket. - - - - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - - - Constructs a new NotFoundException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of NotFoundException - - - - - - - Construct instance of NotFoundException - - - - - - Construct instance of NotFoundException - - - - - - - - - - - Construct instance of NotFoundException - - - - - - - - - - Constructs a new instance of the NotFoundException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The specified game server group has no available game servers to fulfill a ClaimGameServer - request. Clients can retry such requests immediately or after a waiting period. - - - - - Constructs a new OutOfCapacityException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of OutOfCapacityException - - - - - - - Construct instance of OutOfCapacityException - - - - - - Construct instance of OutOfCapacityException - - - - - - - - - - - Construct instance of OutOfCapacityException - - - - - - - - - - Constructs a new instance of the OutOfCapacityException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Information about a player session that was created as part of a StartGameSessionPlacement - request. This object contains only the player ID and player session ID. To retrieve - full details on a player session, call DescribePlayerSessions with the player - session ID. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player that is associated with this player session. - - - - - - Gets and sets the property PlayerSessionId. - - A unique identifier for a player session. - - - - - - Represents a player in matchmaking. When starting a matchmaking request, a player - has a player ID, attributes, and may have latency data. Team information is added - after a match has been successfully completed. - - - - - Gets and sets the property LatencyInMs. - - A set of values, expressed in milliseconds, that indicates the amount of latency that - a player experiences when connected to AWS Regions. If this property is present, FlexMatch - considers placing the match only in Regions for which latency is reported. - - - - If a matchmaker has a rule that evaluates player latency, players must report latency - in order to be matched. If no latency is reported in this scenario, FlexMatch assumes - that no Regions are available to the player and the ticket is not matchable. - - - - - - Gets and sets the property PlayerAttributes. - - A collection of key:value pairs containing player information for use in matchmaking. - Player attribute keys must match the playerAttributes used in a matchmaking - rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": - "deathmatch"}}. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player - - - - - - Gets and sets the property Team. - - Name of the team that the player is assigned to in a match. Team names are defined - in a matchmaking rule set. - - - - - - Regional latency information for a player, used when requesting a new game session - with StartGameSessionPlacement. This value indicates the amount of time lag - that exists when the player is connected to a fleet in the specified Region. The relative - difference between a player's latency values for multiple Regions are used to determine - which fleets are best suited to place a new game session for the player. - - - - - Gets and sets the property LatencyInMilliseconds. - - Amount of time that represents the time lag experienced by the player when connected - to the specified Region. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player associated with the latency data. - - - - - - Gets and sets the property RegionIdentifier. - - Name of the Region that is associated with the latency value. - - - - - - Sets a latency cap for individual players when placing a game session. With a latency - policy in force, a game session cannot be placed in a fleet location where a player - reports latency higher than the cap. Latency policies are used only with placement - request that provide player latency information. Player latency policies can be stacked - to gradually relax latency requirements over time. - - - - Latency policies are part of a GameSessionQueue. - - - - - - Gets and sets the property MaximumIndividualPlayerLatencyMilliseconds. - - The maximum latency value that is allowed for any player, in milliseconds. All policies - must have a value set for this property. - - - - - - Gets and sets the property PolicyDurationSeconds. - - The length of time, in seconds, that the policy is enforced while placing a new game - session. A null value for this property means that the policy is enforced until the - queue times out. - - - - - - Represents a player session. Player sessions are created either for a specific game - session, or as part of a game session placement or matchmaking request. A player session - can represents a reserved player slot in a game session (when status is RESERVED) - or actual player activity in a game session (when status is ACTIVE). - A player session object, including player data, is automatically passed to a game - session when the player connects to the game session and is validated. After the game - session ends, player sessions information is retained for 30 days and then removed. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property DnsName. - - The DNS identifier assigned to the instance that is running the game session. Values - have the following format: - -
  • - - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com. - -
  • - - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. - (See Amazon - EC2 Instance IP Addressing.) - -
- - When connecting to a game session that is running on a TLS-enabled fleet, you must - use the DNS name, not the IP address. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - associated with the GameLift fleet that the player's game session is running on. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that the player's game session is running on. - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session that the player session is connected to. - - - - - - Gets and sets the property IpAddress. - - The IP address of the game session. To connect to a GameLift game server, an app needs - both the IP address and port number. - - - - - - Gets and sets the property PlayerData. - - Developer-defined information related to a player. GameLift does not use this data, - so it can be formatted as needed for use in the game. - - - - - - Gets and sets the property PlayerId. - - A unique identifier for a player that is associated with this player session. - - - - - - Gets and sets the property PlayerSessionId. - - A unique identifier for a player session. - - - - - - Gets and sets the property Port. - - Port number for the game session. To connect to a Amazon GameLift server process, - an app needs both the IP address and port number. - - - - - - Gets and sets the property Status. - - Current status of the player session. - - - - Possible player session statuses include the following: - -
  • - - RESERVED -- The player session request has been received, but the player has - not yet connected to the server process and/or been validated. - -
  • - - ACTIVE -- The player has been validated by the server process and is currently - connected. - -
  • - - COMPLETED -- The player connection has been dropped. - -
  • - - TIMEDOUT -- A player session request was received, but the player did not - connect and/or was not validated within the timeout limit (60 seconds). - -
- - - - - Gets and sets the property TerminationTime. - - A time stamp indicating when this data object was terminated. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Custom prioritization settings for use by a game session queue when placing new game - sessions with available game servers. When defined, this configuration replaces the - default FleetIQ prioritization process, which is as follows: - -
  • - - If player latency data is included in a game session request, destinations and locations - are prioritized first based on lowest average latency (1), then on lowest hosting - cost (2), then on destination list order (3), and finally on location (alphabetical) - (4). This approach ensures that the queue's top priority is to place game sessions - where average player latency is lowest, and--if latency is the same--where the hosting - cost is less, etc. - -
  • - - If player latency data is not included, destinations and locations are prioritized - first on destination list order (1), and then on location (alphabetical) (2). This - approach ensures that the queue's top priority is to place game sessions on the first - destination fleet listed. If that fleet has multiple locations, the game session is - placed on the first location (when listed alphabetically). - -
- - Changing the priority order will affect how game sessions are placed. - - - - Priority configurations are part of a GameSessionQueue. - - - - - - Gets and sets the property LocationOrder. - - The prioritization order to use for fleet locations, when the PriorityOrder - property includes LOCATION. Locations are identified by AWS Region codes - such as us-west-2. Each location can only be listed once. - - - - - - Gets and sets the property PriorityOrder. - - The recommended sequence to use when prioritizing where to place new game sessions. - Each type can only be listed once. - -
  • - - LATENCY -- FleetIQ prioritizes locations where the average player latency - (provided in each game session request) is lowest. - -
  • - - COST -- FleetIQ prioritizes destinations with the lowest current hosting - costs. Cost is evaluated based on the location, instance type, and fleet type (Spot - or On-Demand) for each destination in the queue. - -
  • - - DESTINATION -- FleetIQ prioritizes based on the order that destinations - are listed in the queue configuration. - -
  • - - LOCATION -- FleetIQ prioritizes based on the provided order of locations, - as defined in LocationOrder. - -
- - - - - Container for the parameters to the PutScalingPolicy operation. - Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically - scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs - Amazon GameLift to track a fleet metric and automatically change the fleet's capacity - when a certain threshold is reached. There are two types of scaling policies: target-based - and rule-based. Use a target-based policy to quickly and efficiently manage fleet - scaling; this option is the most commonly used. Use rule-based policies when you need - to exert fine-grained control over auto-scaling. - - - - Fleets can have multiple scaling policies of each type in force at the same time; - you can have one target-based policy, one or multiple rule-based scaling policies, - or both. We recommend caution, however, because multiple auto-scaling policies can - have unintended consequences. - - - - You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions - with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions - with the same fleet action. To stop just one scaling policy--or to permanently remove - it, you must delete the policy with DeleteScalingPolicy. - - - - Learn more about how to work with auto-scaling in Set - Up Fleet Automatic Scaling. - - - - Target-based policy - - - - A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric - tells us how much of a fleet's hosting capacity is ready to host game sessions but - is not currently in use. This is the fleet's buffer; it measures the additional player - demand that the fleet could handle at current capacity. With a target-based policy, - you set your ideal buffer size and leave it to Amazon GameLift to take whatever action - is needed to maintain that target. - - - - For example, you might choose to maintain a 10% buffer for a fleet that has the capacity - to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take - action whenever the fleet's available capacity falls below or rises above 10 game - sessions. Amazon GameLift will start new instances or stop unused instances in order - to return to the 10% buffer. - - - - To create or update a target-based policy, specify a fleet ID and name, and set the - policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - and reference a TargetConfiguration object with your desired buffer value. - Exclude all other parameters. On a successful request, the policy name is returned. - The scaling policy is automatically in force as soon as it's successfully created. - If the fleet's auto-scaling actions are temporarily suspended, the new policy will - be in force once the fleet actions are restarted. - - - - Rule-based policy - - - - A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies - the type of action to initiate when triggered. With a rule-based policy, you can select - from several available fleet metrics. Each policy specifies whether to scale up or - scale down (and by how much), so you need one policy for each type of action. - - - - For example, a policy may make the following statement: "If the percentage of idle - instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - by 10%." - - - - A policy's rule statement has the following structure: - - - - If [MetricName] is [ComparisonOperator] [Threshold] - for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] - to/by [ScalingAdjustment]. - - - - To implement the example, the rule statement would look like this: - - - - If [PercentIdleInstances] is [GreaterThanThreshold] [20] - for [15] minutes, then [PercentChangeInCapacity] to/by [10]. - - - - To create or update a scaling policy, specify a unique combination of name and fleet - ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - rule statement. On a successful request, the policy name is returned. Scaling policies - are automatically in force as soon as they're successfully created. If the fleet's - auto-scaling actions are temporarily suspended, the new policy will be in force once - the fleet actions are restarted. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - - - - Gets and sets the property ComparisonOperator. - - Comparison operator to use when measuring the metric against the threshold value. - - - - - - Gets and sets the property EvaluationPeriods. - - Length of time (in minutes) the metric must be at or beyond the threshold before a - scaling event is triggered. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to apply this policy to. You can use either the - fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR - or DELETING. - - - - - - Gets and sets the property MetricName. - - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. - For detailed descriptions of fleet metrics, see Monitor - Amazon GameLift with Amazon CloudWatch. - -
  • - - ActivatingGameSessions -- Game sessions in the process of being created. - -
  • - - ActiveGameSessions -- Game sessions that are currently running. - -
  • - - ActiveInstances -- Fleet instances that are currently running at least one - game session. - -
  • - - AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, - given current capacity. - -
  • - - AvailablePlayerSessions -- Empty player slots in currently active game sessions. - This includes game sessions that are not currently accepting players. Reserved player - slots are not included. - -
  • - - CurrentPlayerSessions -- Player slots in active game sessions that are being - used by a player or are reserved for a player. - -
  • - - IdleInstances -- Active instances that are currently hosting zero game sessions. - - -
  • - - PercentAvailableGameSessions -- Unused percentage of the total number of game - sessions that a fleet could host simultaneously, given current capacity. Use this - metric for a target-based scaling policy. - -
  • - - PercentIdleInstances -- Percentage of the total number of active instances - that are hosting zero game sessions. - -
  • - - QueueDepth -- Pending game session placement requests, in any queue, where - the current fleet is the top-priority destination. - -
  • - - WaitTime -- Current wait time for pending game session placement requests, - in any queue, where the current fleet is the top-priority destination. - -
- - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet's scaling policy. Policy names - do not need to be unique. A fleet can have only one scaling policy with the same name. - - - - - - Gets and sets the property PolicyType. - - The type of scaling policy to create. For a target-based policy, set the parameter - MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. - For a rule-based policy set the following parameters: MetricName, ComparisonOperator, - Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment. - - - - - - Gets and sets the property ScalingAdjustment. - - Amount of adjustment to make, based on the scaling adjustment type. - - - - - - Gets and sets the property ScalingAdjustmentType. - - The type of adjustment to make to a fleet's instance count (see FleetCapacity): - -
  • - - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the - current instance count. Positive values scale up while negative values scale down. - -
  • - - ExactCapacity -- set the instance count to the scaling adjustment value. - -
  • - - PercentChangeInCapacity -- increase or reduce the current instance count by - the scaling adjustment, read as a percentage. Positive values scale up while negative - values scale down; for example, a value of "-10" scales the fleet down by 10%. - -
- - - - - Gets and sets the property TargetConfiguration. - - An object that contains settings for a target-based scaling policy. - - - - - - Gets and sets the property Threshold. - - Metric value used to trigger a scaling event. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet's scaling policy. Policy names - do not need to be unique. - - - - - - Container for the parameters to the RegisterGameServer operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a new game server resource and notifies GameLift FleetIQ that the game server - is ready to host gameplay and players. This operation is called by a game server process - that is running on an instance in a game server group. Registering game servers enables - GameLift FleetIQ to track available game servers and enables game clients and services - to claim a game server for a new game session. - - - - To register a game server, identify the game server group and instance where the game - server is running, and provide a unique identifier for the game server. You can also - include connection and game server data. When a game client or service requests a - game server by calling ClaimGameServer, this information is returned in the - response. - - - - Once a game server is successfully registered, it is put in status AVAILABLE. - A request to register a game server may fail if the instance it is running on is in - the process of shutting down as part of instance balancing or scale-down activity. - - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property ConnectionInfo. - - Information that is needed to make inbound client connections to the game server. - This might include the IP address and port, DNS name, and other information. - - - - - - Gets and sets the property GameServerData. - - A set of custom game server properties, formatted as a single string value. This data - is passed to a game client or service when it requests information on game servers - using ListGameServers or ClaimGameServer. - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server to register. Game server - IDs are developer-defined and must be unique across all game server groups in your - AWS account. - - - - - - Gets and sets the property InstanceId. - - The unique identifier for the instance where the game server is running. This ID is - available in the instance metadata. EC2 instance IDs use a 17-character format, for - example: i-1234567890abcdef0. - - - - - - This is the response object from the RegisterGameServer operation. - - - - - Gets and sets the property GameServer. - - Object that describes the newly registered game server. - - - - - - Container for the parameters to the RequestUploadCredentials operation. - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build to get credentials for. You can use either the build - ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property StorageLocation. - - Amazon S3 path and key, identifying where the game build files are stored. - - - - - - Gets and sets the property UploadCredentials. - - AWS credentials required when uploading a game build to the storage location. These - credentials have a limited lifespan and are valid only for the build they were issued - for. - - - - - - Container for the parameters to the ResolveAlias operation. - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property AliasId. - - The unique identifier of the alias that you want to retrieve a fleet ID for. You can - use either the alias ID or ARN value. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - associated with the GameLift fleet resource that this alias points to. - - - - - - Gets and sets the property FleetId. - - The fleet identifier that the alias is pointing to. - - - - - - A policy that puts limits on the number of game sessions that a player can create - within a specified span of time. With this policy, you can control players' ability - to consume available resources. - - - - The policy is evaluated when a player tries to create a new game session. On receiving - a CreateGameSession request, GameLift checks that the player (identified - by CreatorId) has created fewer than game session limit in the specified - time period. - - - - The resource creation limit policy is included in FleetAttributes. - - - - - - Gets and sets the property NewGameSessionsPerCreator. - - The maximum number of game sessions that an individual can create during the policy - period. - - - - - - Gets and sets the property PolicyPeriodInMinutes. - - The time span used in evaluating the resource creation limit policy. - - - - - - Container for the parameters to the ResumeGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Reinstates activity on a game server group after it has been suspended. A game server - group might be suspended by theSuspendGameServerGroup operation, or it might - be suspended involuntarily due to a configuration problem. In the second case, you - can manually resume activity on the group once the configuration problem has been - resolved. Refer to the game server group status and status reason for more information - on why group activity is suspended. - - - - To resume activity, specify a game server group ARN and the type of activity to be - resumed. If successful, a GameServerGroup object is returned showing that the - resumed activity is no longer listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - Gets and sets the property ResumeActions. - - The activity to resume for this game server group. - - - - - - This is the response object from the ResumeGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - An object that describes the game server group resource, with the SuspendedActions - property updated to reflect the resumed activity. - - - - - - The routing configuration for a fleet alias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that the alias points to. This value is the fleet - ID, not the fleet ARN. - - - - - - Gets and sets the property Message. - - The message text to be used with a terminal routing strategy. - - - - - - Gets and sets the property Type. - - The type of routing strategy for the alias. - - - - Possible routing types include the following: - -
  • - - SIMPLE - The alias resolves to one specific fleet. Use this type when routing - to active fleets. - -
  • - - TERMINAL - The alias does not resolve to a fleet but instead can be used to - display a message to the user. A terminal alias throws a TerminalRoutingStrategyException - with the RoutingStrategy message embedded. - -
- - - - - A collection of server process configurations that describe the set of processes to - run on each instance in a fleet. Server processes run either an executable in a custom - game build or a Realtime Servers script. GameLift launches the configured processes, - manages their life cycle, and replaces them as needed. Each instance checks regularly - for an updated runtime configuration. - - - - A GameLift instance is limited to 50 processes running concurrently. To calculate - the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions - parameter for each ServerProcess. Learn more about - Running Multiple Processes on a Fleet. - - - - Related actions - - - - DescribeRuntimeConfiguration | UpdateRuntimeConfiguration - - - - - - Gets and sets the property GameSessionActivationTimeoutSeconds. - - The maximum amount of time (in seconds) allowed to launch a new game session and have - it report ready to host players. During this time, the game session is in status ACTIVATING. - If the game session does not become active before the timeout, it is ended and the - game session status is changed to TERMINATED. - - - - - - Gets and sets the property MaxConcurrentGameSessionActivations. - - The number of game sessions in status ACTIVATING to allow on an instance. - This setting limits the instance resources that can be used for new game activations - at any one time. - - - - - - Gets and sets the property ServerProcesses. - - A collection of server process configurations that identify what server processes - to run on each instance in a fleet. - - - - - - The location in Amazon S3 where build or script files are stored for access by Amazon - GameLift. This location is specified in CreateBuild, CreateScript, and - UpdateScript requests. - - - - - Gets and sets the property Bucket. - - An Amazon S3 bucket identifier. This is the name of the S3 bucket. - - - - GameLift currently does not support uploading from Amazon S3 buckets with names that - contain a dot (.). - - - - - - - Gets and sets the property Key. - - The name of the zip file that contains the build files or script files. - - - - - - Gets and sets the property ObjectVersion. - - The version of the file, if object versioning is turned on for the bucket. Amazon - GameLift uses this information when retrieving files from an S3 bucket that you own. - Use this parameter to specify a specific version of the file. If not set, the latest - version of the file is retrieved. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) - for an IAM role that allows Amazon GameLift to access the S3 bucket. - - - - - - Rule that controls how a fleet is scaled. Scaling policies are uniquely identified - by the combination of name and fleet ID. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - - - - Gets and sets the property ComparisonOperator. - - Comparison operator to use when measuring a metric against the threshold value. - - - - - - Gets and sets the property EvaluationPeriods. - - Length of time (in minutes) the metric must be at or beyond the threshold before a - scaling event is triggered. - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that is associated with this scaling policy. - - - - - - Gets and sets the property Location. - - - - - - - - Gets and sets the property MetricName. - - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. - For detailed descriptions of fleet metrics, see Monitor - Amazon GameLift with Amazon CloudWatch. - -
  • - - ActivatingGameSessions -- Game sessions in the process of being created. - -
  • - - ActiveGameSessions -- Game sessions that are currently running. - -
  • - - ActiveInstances -- Fleet instances that are currently running at least one - game session. - -
  • - - AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, - given current capacity. - -
  • - - AvailablePlayerSessions -- Empty player slots in currently active game sessions. - This includes game sessions that are not currently accepting players. Reserved player - slots are not included. - -
  • - - CurrentPlayerSessions -- Player slots in active game sessions that are being - used by a player or are reserved for a player. - -
  • - - IdleInstances -- Active instances that are currently hosting zero game sessions. - - -
  • - - PercentAvailableGameSessions -- Unused percentage of the total number of game - sessions that a fleet could host simultaneously, given current capacity. Use this - metric for a target-based scaling policy. - -
  • - - PercentIdleInstances -- Percentage of the total number of active instances - that are hosting zero game sessions. - -
  • - - QueueDepth -- Pending game session placement requests, in any queue, where - the current fleet is the top-priority destination. - -
  • - - WaitTime -- Current wait time for pending game session placement requests, - in any queue, where the current fleet is the top-priority destination. - -
- - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet's scaling policy. Policy names - do not need to be unique. - - - - - - Gets and sets the property PolicyType. - - The type of scaling policy to create. For a target-based policy, set the parameter - MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. - For a rule-based policy set the following parameters: MetricName, ComparisonOperator, - Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment. - - - - - - Gets and sets the property ScalingAdjustment. - - Amount of adjustment to make, based on the scaling adjustment type. - - - - - - Gets and sets the property ScalingAdjustmentType. - - The type of adjustment to make to a fleet's instance count (see FleetCapacity): - -
  • - - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the - current instance count. Positive values scale up while negative values scale down. - -
  • - - ExactCapacity -- set the instance count to the scaling adjustment value. - -
  • - - PercentChangeInCapacity -- increase or reduce the current instance count by - the scaling adjustment, read as a percentage. Positive values scale up while negative - values scale down. - -
- - - - - Gets and sets the property Status. - - Current status of the scaling policy. The scaling policy can be in force only when - in an ACTIVE status. Scaling policies can be suspended for individual - fleets (see StopFleetActions; if suspended for a fleet, the policy status does - not change. View a fleet's stopped actions by calling DescribeFleetCapacity. - -
  • - - ACTIVE -- The scaling policy can be used for auto-scaling a fleet. - -
  • - - UPDATE_REQUESTED -- A request to update the scaling policy has been received. - -
  • - - UPDATING -- A change is being made to the scaling policy. - -
  • - - DELETE_REQUESTED -- A request to delete the scaling policy has been received. - -
  • - - DELETING -- The scaling policy is being deleted. - -
  • - - DELETED -- The scaling policy has been deleted. - -
  • - - ERROR -- An error occurred in creating the policy. It should be removed and - recreated. - -
- - - - - Gets and sets the property TargetConfiguration. - - An object that contains settings for a target-based scaling policy. - - - - - - Gets and sets the property Threshold. - - Metric value used to trigger a scaling event. - - - - - - Gets and sets the property UpdateStatus. - - The current status of the fleet's scaling policies in a requested fleet location. - The status PENDING_UPDATE indicates that an update was requested for - the fleet but has not yet been completed for the location. - - - - - - Properties describing a Realtime script. - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property CreationTime. - - A time stamp indicating when this data object was created. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a script. Script names do not need to - be unique. - - - - - - Gets and sets the property ScriptArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift script resource and uniquely identifies it. ARNs are - unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId - value. - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script - - - - - - Gets and sets the property SizeOnDisk. - - The file size of the uploaded Realtime script, expressed in bytes. When files are - uploaded from an S3 location, this value remains at "0". - - - - - - Gets and sets the property StorageLocation. - - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. - - - - - - Container for the parameters to the SearchGameSessions operation. - Retrieves all active game sessions that match a set of search criteria and sorts them - into a specified order. - - - - When searching for game sessions, you specify exactly where you want to search and - provide a search filter expression, a sort expression, or both. A search request can - search only one fleet, but it can search all of a fleet's locations. - - - - This operation can be used in the following ways: - -
  • - - To search all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID. This approach returns game sessions in the fleet's home - Region and all remote locations that fit the search criteria. - -
  • - - To search all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name. For location, you can specify a fleet's - home Region or any remote location. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. Search finds game sessions that are in ACTIVE - status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. - - - - You can search or sort by the following game session attributes: - -
  • - - gameSessionId -- A unique identifier for the game session. You can use either - a GameSessionId or GameSessionArn value. - -
  • - - gameSessionName -- Name assigned to a game session. This value is set when - requesting a new game session with CreateGameSession or updating with UpdateGameSession. - Game session names do not need to be unique to a game session. - -
  • - - gameSessionProperties -- Custom data defined in a game session's GameProperty - parameter. GameProperty values are stored as key:value pairs; the filter - expression must indicate the key and a string to search the data values for. For example, - to search for game sessions with custom data containing the key:value pair "gameMode:brawl", - specify the following: gameSessionProperties.gameMode = "brawl". All - custom data values are searched as strings. - -
  • - - maximumSessions -- Maximum number of player sessions allowed for a game session. - This value is set when requesting a new game session with CreateGameSession - or updating with UpdateGameSession. - -
  • - - creationTimeMillis -- Value indicating when a game session was created. It - is expressed in Unix time as milliseconds. - -
  • - - playerSessionCount -- Number of players currently connected to a game session. - This value changes rapidly as players join the session or drop out. - -
  • - - hasAvailablePlayerSessions -- Boolean value indicating whether a game session - has reached its maximum number of players. It is highly recommended that all search - requests include this filter attribute to optimize search performance and return only - sessions that players can join. - -
- - Returned values for playerSessionCount and hasAvailablePlayerSessions - change quickly as players join sessions and others drop out. Results should be considered - a snapshot in time. Be sure to refresh search results often, and handle sessions that - fill up before a player can join. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias associated with the fleet to search for active game - sessions. You can use either the alias ID or ARN value. Each request must reference - either a fleet ID or alias ID, but not both. - - - - - - Gets and sets the property FilterExpression. - - String containing the search criteria for the session search. If no filter expression - is included, the request returns results for all game sessions in the fleet that are - in ACTIVE status. - - - - A filter expression can contain one or multiple conditions. Each condition consists - of the following: - -
  • - - Operand -- Name of a game session attribute. Valid values are gameSessionName, - gameSessionId, gameSessionProperties, maximumSessions, - creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions. - -
  • - - Comparator -- Valid comparators are: =, <>, - <, >, <=, >=. - -
  • - - Value -- Value to be searched for. Values may be numbers, boolean values (true/false) - or strings depending on the operand. String values are case sensitive and must be - enclosed in single quotes. Special characters must be escaped. Boolean and string - values can only be used with the comparators = and <>. - For example, the following filter expression searches on gameSessionName: - "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'". - -
- - To chain multiple conditions in a single expression, use the logical keywords AND, - OR, and NOT and parentheses as needed. For example: x - AND y AND NOT z, NOT (x OR y). - - - - Session search evaluates conditions from left to right using the following precedence - rules: - -
  1. - - =, <>, <, >, <=, - >= - -
  2. - - Parentheses - -
  3. - - NOT - -
  4. - - AND - -
  5. - - OR - -
- - For example, this filter expression retrieves game sessions hosting at least ten players - that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true". - - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to search for active game sessions. You can use - either the fleet ID or ARN value. Each request must reference either a fleet ID or - alias ID, but not both. - - - - - - Gets and sets the property Limit. - - The maximum number of results to return. Use this parameter with NextToken - to get results as a set of sequential pages. The maximum number of results returned - is 20, even if this value is not set or is set higher than 20. - - - - - - Gets and sets the property Location. - - A fleet location to search for game sessions. You can specify a fleet's home Region - or a remote location. Use the AWS Region code format, such as us-west-2. - - - - - - - - - - - Gets and sets the property NextToken. - - A token that indicates the start of the next sequential page of results. Use the token - that is returned with a previous call to this operation. To start at the beginning - of the result set, do not specify a value. - - - - - - Gets and sets the property SortExpression. - - Instructions on how to sort the search results. If no sort expression is included, - the request returns results in random order. A sort expression consists of the following - elements: - -
  • - - Operand -- Name of a game session attribute. Valid values are gameSessionName, - gameSessionId, gameSessionProperties, maximumSessions, - creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions. - -
  • - - Order -- Valid sort orders are ASC (ascending) and DESC - (descending). - -
- - For example, this sort expression returns the oldest active sessions first: "SortExpression": - "creationTimeMillis ASC". Results with a null value for the sort operand are - returned at the end of the list. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessions. - - A collection of objects containing game session properties for each session that matches - the request. - - - - - - Gets and sets the property NextToken. - - A token that indicates where to resume retrieving results on the next call to this - operation. If no token is returned, these results represent the end of the list. - - - - - - A set of instructions for launching server processes on each instance in a fleet. - Server processes run either an executable in a custom game build or a Realtime Servers - script. Server process configurations are part of a fleet's RuntimeConfiguration. - - - - - Gets and sets the property ConcurrentExecutions. - - The number of server processes using this configuration that run concurrently on each - instance. - - - - - - Gets and sets the property LaunchPath. - - The location of a game build executable or the Realtime script file that contains - the Init() function. Game builds and Realtime scripts are installed on - instances at the root: - -
  • - - Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" - - -
  • - - Linux: /local/game. Examples: "/local/game/MyGame/server.exe" - or "/local/game/MyRealtimeScript.js" - -
- - - - - Gets and sets the property Parameters. - - An optional list of parameters to pass to the server executable or Realtime script - on launch. - - - - - - Container for the parameters to the StartFleetActions operation. - Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. - For multi-location fleets, fleet actions are managed separately for each location. - Currently, this operation is used to restart a fleet's auto-scaling activity. - - - - This operation can be used in the following ways: - -
  • - - To restart actions on instances in the fleet's home Region, provide a fleet ID and - the type of actions to resume. - -
  • - - To restart actions on instances in one of the fleet's remote locations, provide a - fleet ID, a location name, and the type of actions to resume. - -
- - If successful, GameLift once again initiates scaling events as triggered by the fleet's - scaling policies. If actions on the fleet location were never stopped, this operation - will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes - or DescribeFleetLocationAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - - - - Gets and sets the property Actions. - - List of actions to restart on the fleet. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to restart actions on. You can use either the fleet - ID or ARN value. - - - - - - Gets and sets the property Location. - - The fleet location to restart fleet actions for. Specify a location in the form of - an AWS Region code, such as us-west-2. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to restart actions on. - - - - - - Container for the parameters to the StartGameSessionPlacement operation. - Places a request for a new game session in a queue (see CreateGameSessionQueue). - When processing a placement request, Amazon GameLift searches for available resources - on the queue's destinations, scanning each until it finds resources or the placement - request times out. - - - - A game session placement request can also request player sessions. When a new game - session is successfully created, Amazon GameLift creates a player session for each - player included in the request. - - - - When placing a game session, by default Amazon GameLift tries each fleet in the order - they are listed in the queue configuration. Ideally, a queue's destinations are listed - in preference order. - - - - Alternatively, when requesting a game session with players, you can also provide latency - data for each player in relevant Regions. Latency data indicates the performance lag - a player experiences when connected to a fleet in the Region. Amazon GameLift uses - latency data to reorder the list of destinations to place the game session in a Region - with minimal lag. If latency data is provided for multiple players, Amazon GameLift - calculates each Region's average lag for all players and reorders to get the best - game play across all players. - - - - To place a new game session request, specify the following: - -
  • - - The queue name and a set of game session properties and settings - -
  • - - A unique ID (such as a UUID) for the placement. You use this ID to track the status - of the placement request - -
  • - - (Optional) A set of player data and a unique player ID for each player that you are - joining to the new game session (player data is optional, but if you include it, you - must also provide a unique ID for each player) - -
  • - - Latency data for all players (if you want to optimize game play for the players) - -
- - If successful, a new game session placement is created. - - - - To track the status of a placement request, call DescribeGameSessionPlacement - and check the request's status. If the status is FULFILLED, a new game - session has been created and a game session ARN and Region are referenced. If the - placement request times out, you can resubmit the request or retry it with a different - queue. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property DesiredPlayerSessions. - - Set of information on each player to create a player session for. - - - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session (see Start - a Game Session). - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session (see Start - a Game Session). - - - - - - Gets and sets the property GameSessionName. - - A descriptive label that is associated with a game session. Session names do not need - to be unique. - - - - - - Gets and sets the property GameSessionQueueName. - - Name of the queue to use to place the new game session. You can use either the queue - name or ARN value. - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players that can be connected simultaneously to the game session. - - - - - - Gets and sets the property PlacementId. - - A unique identifier to assign to the new game session placement. This value is developer-defined. - The value must be unique across all Regions and cannot be reused unless you are resubmitting - a canceled or timed-out placement request. - - - - - - Gets and sets the property PlayerLatencies. - - A set of values, expressed in milliseconds, that indicates the amount of latency that - a player experiences when connected to AWS Regions. This information is used to try - to place the new game session where it can offer the best possible gameplay experience - for the players. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionPlacement. - - Object that describes the newly created game session placement. This object includes - all the information provided in the request, as well as start/end time stamps and - placement status. - - - - - - Container for the parameters to the StartMatchBackfill operation. - Finds new players to fill open slots in currently running game sessions. The backfill - match process is essentially identical to the process of forming new matches. Backfill - requests use the same matchmaker that was used to make the original match, and they - provide matchmaking data for all players currently in the game session. FlexMatch - uses this information to select new players so that backfilled match continues to - meet the original match requirements. - - - - When using FlexMatch with GameLift managed hosting, you can request a backfill match - from a client service by calling this operation with a GameSession identifier. - You also have the option of making backfill requests directly from your game server. - In response to a request, FlexMatch creates player sessions for the new players, updates - the GameSession resource, and sends updated matchmaking data to the game - server. You can request a backfill match at any point after a game session is started. - Each game session can have only one active backfill request at a time; a subsequent - request automatically replaces the earlier request. - - - - When using FlexMatch as a standalone component, request a backfill match by calling - this operation without a game session identifier. As with newly formed matches, matchmaking - results are returned in a matchmaking event so that your game can update the game - session that is being backfilled. - - - - To request a backfill match, specify a unique ticket ID, the original matchmaking - configuration, and matchmaking data for all current players in the game session being - backfilled. Optionally, specify the GameSession ARN. If successful, a - match backfill ticket is created and returned with status set to QUEUED. Track the - status of backfill tickets using the same method for tracking tickets for new matches. - - - - Learn more - - - - - Backfill existing games with FlexMatch - - - - - Matchmaking events (reference) - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - - - - Gets and sets the property ConfigurationName. - - Name of the matchmaker to use for this request. You can use either the configuration - name or ARN value. The ARN of the matchmaker that was used with the original game - session is listed in the GameSession object, MatchmakerData property. - - - - - - Gets and sets the property GameSessionArn. - - A unique identifier for the game session. Use the game session ID. When using FlexMatch - as a standalone matchmaking solution, this parameter is not needed. - - - - - - Gets and sets the property Players. - - Match information on all players that are currently assigned to the game session. - This information is used by the matchmaker to find new players and add them to the - existing game. - -
  • - - PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession - object, MatchmakerData property, for all players who are currently assigned - to the game session. The matchmaker data is in JSON syntax, formatted as a string. - For more details, see - Match Data. - -
  • - - LatencyInMs -- If the matchmaker uses player latency, include a latency value, in - milliseconds, for the Region that the game session is currently in. Do not include - latency values for any other Region. - -
- - - - - Gets and sets the property TicketId. - - A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon - GameLift will generate one in the form of a UUID. Use this identifier to track the - match backfill ticket status and retrieve match results. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property MatchmakingTicket. - - Ticket representing the backfill matchmaking request. This object includes the information - in the request, ticket status, and match results as generated during the matchmaking - process. - - - - - - Container for the parameters to the StartMatchmaking operation. - Uses FlexMatch to create a game match for a group of players based on custom matchmaking - rules. With games that use GameLift managed hosting, this operation also triggers - GameLift to find hosting resources and start a new game session for the new match. - Each matchmaking request includes information on one or more players and specifies - the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch - attempts to build a match that includes all players in the request, placing them in - the same team and finding additional players as needed to fill the match. - - - - To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - and include the players to be matched. You must also include any player attributes - that are required by the matchmaking configuration's rule set. If successful, a matchmaking - ticket is returned with status set to QUEUED. - - - - Track matchmaking events to respond as needed and acquire game session connection - information for successfully completed matches. Ticket status updates are tracked - using event notification through Amazon Simple Notification Service (SNS), which is - defined in the matchmaking configuration. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - - - - Gets and sets the property ConfigurationName. - - Name of the matchmaking configuration to use for this request. Matchmaking configurations - must exist in the same Region as this request. You can use either the configuration - name or ARN value. - - - - - - Gets and sets the property Players. - - Information on each player to be matched. This information must include a player ID, - and may contain player attributes and latency data to be used in the matchmaking process. - After a successful match, Player objects contain the name of the team - the player is assigned to. - - - - - - Gets and sets the property TicketId. - - A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon - GameLift will generate one in the form of a UUID. Use this identifier to track the - matchmaking ticket status and retrieve match results. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property MatchmakingTicket. - - Ticket representing the matchmaking request. This object include the information included - in the request, ticket status, and match results as generated during the matchmaking - process. - - - - - - Container for the parameters to the StopFleetActions operation. - Suspends certain types of activity in a fleet location. Currently, this operation - is used to stop auto-scaling activity. For multi-location fleets, fleet actions are - managed separately for each location. - - - - Stopping fleet actions has several potential purposes. It allows you to temporarily - stop auto-scaling activity but retain your scaling policies for use in the future. - For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out - of it for certain locations. - - - - This operation can be used in the following ways: - -
  • - - To stop actions on instances in the fleet's home Region, provide a fleet ID and the - type of actions to suspend. - -
  • - - To stop actions on instances in one of the fleet's remote locations, provide a fleet - ID, a location name, and the type of actions to suspend. - -
- - If successful, GameLift no longer initiates scaling events except in response to manual - changes using UpdateFleetCapacity. You can view a fleet's stopped actions using - DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended - activity can be restarted using StartFleetActions. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - - - - Gets and sets the property Actions. - - List of actions to suspend on the fleet. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to stop actions on. You can use either the fleet - ID or ARN value. - - - - - - Gets and sets the property Location. - - The fleet location to stop fleet actions for. Specify a location in the form of an - AWS Region code, such as us-west-2. - - - - - - Represents the input for a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to stop actions on. - - - - - - Container for the parameters to the StopGameSessionPlacement operation. - Cancels a game session placement that is in PENDING status. To stop a - placement, provide the placement ID values. If successful, the placement is moved - to CANCELLED status. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property PlacementId. - - A unique identifier for a game session placement to cancel. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionPlacement. - - Object that describes the canceled game session placement, with CANCELLED - status and an end time stamp. - - - - - - Container for the parameters to the StopMatchmaking operation. - Cancels a matchmaking ticket or match backfill ticket that is currently being processed. - To stop the matchmaking operation, specify the ticket ID. If successful, work on the - ticket is stopped, and the ticket status is changed to CANCELLED. - - - - This call is also used to turn off automatic backfill for an individual game session. - This is for game sessions that are created with a matchmaking configuration that has - automatic backfill enabled. The ticket ID is included in the MatchmakerData - of an updated game session object, which is provided to the game server. - - - - If the operation is successful, the service sends back an empty JSON struct with the - HTTP 200 response (not an empty HTTP body). - - - - Learn more - - - - - Add FlexMatch to a game client - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - - - - Gets and sets the property TicketId. - - A unique identifier for a matchmaking ticket. - - - - - - This is the response object from the StopMatchmaking operation. - - - - - Container for the parameters to the SuspendGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Temporarily stops activity on a game server group without terminating instances or - the game server group. You can restart activity by calling ResumeGameServerGroup. - You can suspend the following activity: - -
  • - - Instance type replacement - This activity evaluates the current game hosting - viability of all Spot instance types that are defined for the game server group. It - updates the Auto Scaling group to remove nonviable Spot Instance types, which have - a higher chance of game server interruptions. It then balances capacity across the - remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling - group continues with its current balance, regardless of viability. Instance protection, - utilization metrics, and capacity scaling activities continue to be active. - -
- - To suspend activity, specify a game server group ARN and the type of activity to be - suspended. If successful, a GameServerGroup object is returned showing that - the activity is listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - Gets and sets the property SuspendActions. - - The activity to suspend for this game server group. - - - - - - This is the response object from the SuspendGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - An object that describes the game server group resource, with the SuspendedActions - property updated to reflect the suspended activity. - - - - - - A label that can be assigned to a GameLift resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - - - - Gets and sets the property Key. - - The key for a developer-defined key:value pair for tagging an AWS resource. - - - - - - Gets and sets the property Value. - - The value for a developer-defined key:value pair for tagging an AWS resource. - - - - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - - - Constructs a new TaggingFailedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TaggingFailedException - - - - - - - Construct instance of TaggingFailedException - - - - - - Construct instance of TaggingFailedException - - - - - - - - - - - Construct instance of TaggingFailedException - - - - - - - - - - Constructs a new instance of the TaggingFailedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the TagResource operation. - Assigns a tag to a GameLift resource. AWS resource tags provide an additional management - tool set. You can use tags to organize resources, create IAM permissions policies - to manage access to groups of resources, customize AWS cost breakdowns, etc. This - operation handles the permissions necessary to manage tags for the following GameLift - resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To add a tag to a resource, specify the unique ARN value for the resource and provide - a tag list containing one or more tags. The operation succeeds even if the list includes - tags that are already assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - - - - Gets and sets the property ResourceARN. - - The Amazon Resource Name (ARN) - that is assigned to and uniquely identifies the GameLift resource that you want to - assign tags to. GameLift resource ARNs are included in the data object for the resource, - which can be retrieved by calling a List or Describe operation for the resource type. - - - - - - - Gets and sets the property Tags. - - A list of one or more tags to assign to the specified GameLift resource. Tags are - developer-defined and structured as key-value pairs. The maximum tag limit may be - lower than stated. See - Tagging AWS Resources for actual tagging limits. - - - - - - This is the response object from the TagResource operation. - - - - - Settings for a target-based scaling policy (see ScalingPolicy. A target-based - policy tracks a particular fleet metric specifies a target value for the metric. As - player usage changes, the policy triggers Amazon GameLift to adjust capacity so that - the metric returns to the target value. The target configuration specifies settings - as needed for the target based policy, including the target value. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - - - - Gets and sets the property TargetValue. - - Desired value to use with a target-based scaling policy. The value must be relevant - for whatever metric the scaling policy is using. For example, in a policy using the - metric PercentAvailableGameSessions, the target value should be the preferred size - of the fleet's buffer (the percent of capacity that should be idle and ready for new - game sessions). - - - - - - This data type is used with the GameLift FleetIQ and game server groups. - - - - Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy. - These settings are used to create a target-based policy that tracks the GameLift FleetIQ - metric "PercentUtilizedGameServers" and specifies a target value for - the metric. As player usage changes, the policy triggers to adjust the game server - group capacity so that the metric returns to the target value. - - - - - - Gets and sets the property TargetValue. - - Desired value to use with a game server group target-based scaling policy. - - - - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - - - Constructs a new TerminalRoutingStrategyException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of TerminalRoutingStrategyException - - - - - - - Construct instance of TerminalRoutingStrategyException - - - - - - Construct instance of TerminalRoutingStrategyException - - - - - - - - - - - Construct instance of TerminalRoutingStrategyException - - - - - - - - - - Constructs a new instance of the TerminalRoutingStrategyException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The client failed authentication. Clients should not retry such requests. - - - - - Constructs a new UnauthorizedException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnauthorizedException - - - - - - - Construct instance of UnauthorizedException - - - - - - Construct instance of UnauthorizedException - - - - - - - - - - - Construct instance of UnauthorizedException - - - - - - - - - - Constructs a new instance of the UnauthorizedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The requested operation is not supported in the Region specified. - - - - - Constructs a new UnsupportedRegionException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of UnsupportedRegionException - - - - - - - Construct instance of UnsupportedRegionException - - - - - - Construct instance of UnsupportedRegionException - - - - - - - - - - - Construct instance of UnsupportedRegionException - - - - - - - - - - Constructs a new instance of the UnsupportedRegionException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Container for the parameters to the UntagResource operation. - Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize - AWS resources for a range of purposes. This operation handles the permissions necessary - to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To remove a tag from a resource, specify the unique ARN value for the resource and - provide a string list containing one or more tags to be removed. This operation succeeds - even if the list includes tags that are not currently assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - - - - Gets and sets the property ResourceARN. - - The Amazon Resource Name (ARN) - that is assigned to and uniquely identifies the GameLift resource that you want to - remove tags from. GameLift resource ARNs are included in the data object for the resource, - which can be retrieved by calling a List or Describe operation for the resource type. - - - - - - - Gets and sets the property TagKeys. - - A list of one or more tag keys to remove from the specified GameLift resource. An - AWS resource can have only one tag with a specific tag key, so specifying the tag - key identifies which tag to remove. - - - - - - This is the response object from the UntagResource operation. - - - - - Container for the parameters to the UpdateAlias operation. - Updates properties for an alias. To update properties, specify the alias ID to be - updated and provide the information to be changed. To reassign an alias to another - fleet, provide an updated routing strategy. If successful, the updated alias record - is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - - - - Gets and sets the property AliasId. - - A unique identifier for the alias that you want to update. You can use either the - alias ID or ARN value. - - - - - - Gets and sets the property Description. - - A human-readable description of the alias. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with an alias. Alias names do not need to be - unique. - - - - - - Gets and sets the property RoutingStrategy. - - The routing configuration, including routing type and fleet target, for the alias. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Alias. - - The updated alias resource. - - - - - - Container for the parameters to the UpdateBuild operation. - Updates metadata in a build resource, including the build name and version. To update - the metadata, specify the build ID to update and provide the new values. If successful, - a build object containing the updated metadata is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - - - - Gets and sets the property BuildId. - - A unique identifier for the build to update. You can use either the build ID or ARN - value. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a build. Build names do not need to be - unique. - - - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Build. - - The updated build resource. - - - - - - Container for the parameters to the UpdateFleetAttributes operation. - Updates a fleet's mutable attributes, including game session protection and resource - creation limits. - - - - To update fleet attributes, specify the fleet ID and the property values that you - want to change. - - - - If successful, an updated FleetAttributes object is returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - - - - Gets and sets the property Description. - - A human-readable description of a fleet. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to update attribute metadata for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property MetricGroups. - - The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch - to aggregate the metrics from multiple fleets. Provide an existing metric group name, - or create a new metric group by providing a new name. A fleet can only be in one metric - group at a time. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a fleet. Fleet names do not need to be - unique. - - - - - - Gets and sets the property NewGameSessionProtectionPolicy. - - The game session protection policy to apply to all new instances created in this fleet. - Instances that already exist are not affected. You can set protection for individual - instances using UpdateGameSession. - -
  • - - NoProtection -- The game session can be terminated during a scale-down event. - -
  • - - FullProtection -- If the game session is in an ACTIVE status, - it cannot be terminated during a scale-down event. - -
- - - - - Gets and sets the property ResourceCreationLimitPolicy. - - Policy settings that limit the number of game sessions an individual player can create - over a span of time. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that was updated. - - - - - - Container for the parameters to the UpdateFleetCapacity operation. - Updates capacity settings for a fleet. For fleets with multiple locations, use this - operation to manage capacity settings in each location individually. Fleet capacity - determines the number of game sessions and players that can be hosted based on the - fleet configuration. Use this operation to set the following fleet capacity properties: - - -
  • - - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's - capacity to a value outside of this range, whether the capacity is changed manually - or through automatic scaling. - -
  • - - Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet - location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits - to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider - using automatic scaling to adjust capacity based on player demand. - -
- - This operation can be used in the following ways: - -
  • - - To update capacity for a fleet's home Region, or if the fleet has no remote locations, - omit the Location parameter. The fleet must be in ACTIVE - status. - -
  • - - To update capacity for a fleet's remote location, include the Location - parameter set to the location to be updated. The location must be in ACTIVE - status. - -
- - If successful, capacity settings are updated immediately. In response a change in - desired capacity, GameLift initiates steps to start new instances or terminate existing - instances in the requested fleet location. This continues until the location's active - instance count matches the new desired instance count. You can track a fleet's current - capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. - If the requested desired instance count is higher than the instance type's limit, - the LimitExceeded exception occurs. - - - - Learn more - - - - Scaling - fleet capacity - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - - - - Gets and sets the property DesiredInstances. - - The number of EC2 instances you want to maintain in the specified fleet location. - This value must fall between the minimum and maximum size limits. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to update capacity settings for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property Location. - - The name of a remote location to update fleet capacity settings for, in the form of - an AWS Region code such as us-west-2. - - - - - - Gets and sets the property MaxSize. - - The maximum number of instances that are allowed in the specified fleet location. - If this parameter is not set, the default is 1. - - - - - - Gets and sets the property MinSize. - - The minimum number of instances that are allowed in the specified fleet location. - If this parameter is not set, the default is 0. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. - - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that was updated. - - - - - - Gets and sets the property Location. - - The remote location being updated, expressed as an AWS Region code, such as us-west-2. - - - - - - Container for the parameters to the UpdateFleetPortSettings operation. - Updates permissions that allow inbound traffic to connect to game sessions that are - being hosted on instances in the fleet. - - - - To update settings, specify the fleet ID to be updated and specify the changes to - be made. List the permissions you want to add in InboundPermissionAuthorizations, - and permissions you want to remove in InboundPermissionRevocations. Permissions - to be removed must match existing fleet permissions. - - - - If successful, the fleet ID for the updated fleet is returned. For fleets with remote - locations, port setting updates can take time to propagate across all locations. You - can check the status of updates in each location by calling DescribeFleetPortSettings - with a location name. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to update port settings for. You can use either - the fleet ID or ARN value. - - - - - - Gets and sets the property InboundPermissionAuthorizations. - - A collection of port settings to be added to the fleet resource. - - - - - - Gets and sets the property InboundPermissionRevocations. - - A collection of port settings to be removed from the fleet resource. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet that was updated. - - - - - - Container for the parameters to the UpdateGameServerGroup operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling - group properties are updated on the Auto Scaling group directly, including the launch - template, Auto Scaling policies, and maximum/minimum/desired instance counts. - - - - To update the game server group, specify the game server group ID and provide the - updated values. Before applying the updates, the new values are validated to ensure - that GameLift FleetIQ can continue to perform instance balancing activity. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - - - - Gets and sets the property BalancingStrategy. - - Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances - in the game server group. Method options include the following: - -
  • - - SPOT_ONLY - Only Spot Instances are used in the game server group. If - Spot Instances are unavailable or not viable for game hosting, the game server group - provides no hosting capacity until Spot Instances can again be used. Until then, no - new instances are started, and the existing nonviable Spot Instances are terminated - (after current gameplay ends) and are not replaced. - -
  • - - SPOT_PREFERRED - (default value) Spot Instances are used whenever available - in the game server group. If Spot Instances are unavailable, the game server group - continues to provide hosting capacity by falling back to On-Demand Instances. Existing - nonviable Spot Instances are terminated (after current gameplay ends) and are replaced - with new On-Demand Instances. - -
  • - - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server - group. No Spot Instances are used, even when available, while this balancing strategy - is in force. - -
- - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group. Use either the GameServerGroup - name or ARN value. - - - - - - Gets and sets the property GameServerProtectionPolicy. - - A flag that indicates whether instances in the game server group are protected from - early termination. Unprotected instances that have active game servers running might - be terminated during a scale-down event, causing players to be dropped from the game. - Protected instances cannot be terminated while there are active game servers running - except in the event of a forced game server group deletion (see ). An exception to - this is with Spot Instances, which can be terminated by AWS regardless of protection - status. This property is set to NO_PROTECTION by default. - - - - - - Gets and sets the property InstanceDefinitions. - - An updated list of EC2 instance types to use in the Auto Scaling group. The instance - definitions must specify at least two different instance types that are supported - by GameLift FleetIQ. This updated list replaces the entire current list of instance - definitions for the game server group. For more information on instance types, see - EC2 - Instance Types in the Amazon EC2 User Guide. You can optionally specify - capacity weighting for each instance type. If no weight value is specified for an - instance type, it is set to the default value "1". For more information about capacity - weighting, see - Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling - User Guide. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) - for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. - - - - - - This is the response object from the UpdateGameServerGroup operation. - - - - - Gets and sets the property GameServerGroup. - - An object that describes the game server group resource with updated properties. - - - - - - Container for the parameters to the UpdateGameServer operation. - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates information about a registered game server to help GameLift FleetIQ to track - game server availability. This operation is called by a game server process that is - running on an instance in a game server group. - - - - Use this operation to update the following types of game server information. You can - make all three types of updates in the same request: - -
  • - - To update the game server's utilization status, identify the game server and game - server group and specify the current utilization status. Use this status to identify - when game servers are currently hosting games and when they are available to be claimed. - -
  • - - To report health status, identify the game server and game server group and set health - check to HEALTHY. If a game server does not report health status for - a certain length of time, the game server is no longer considered healthy. As a result, - it will be eventually deregistered from the game server group to avoid affecting utilization - metrics. The best practice is to report health every 60 seconds. - -
  • - - To change game server metadata, provide updated game server data. - -
- - Once a game server is successfully updated, the relevant statuses and timestamps are - updated. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - - - - Gets and sets the property GameServerData. - - A set of custom game server properties, formatted as a single string value. This data - is passed to a game client or service when it requests information on game servers - using ListGameServers or ClaimGameServer. - - - - - - Gets and sets the property GameServerGroupName. - - A unique identifier for the game server group where the game server is running. Use - either the GameServerGroup name or ARN value. - - - - - - Gets and sets the property GameServerId. - - A custom string that uniquely identifies the game server to update. - - - - - - Gets and sets the property HealthCheck. - - Indicates health status of the game server. A request that includes this parameter - updates the game server's LastHealthCheckTime timestamp. - - - - - - Gets and sets the property UtilizationStatus. - - Indicates whether the game server is available or is currently hosting gameplay. - - - - - - This is the response object from the UpdateGameServer operation. - - - - - Gets and sets the property GameServer. - - Object that describes the newly updated game server. - - - - - - Container for the parameters to the UpdateGameSessionQueue operation. - Updates the configuration of a game session queue, which determines how the queue - processes new game session requests. To update settings, specify the queue name to - be updated and provide the new settings. When updating destinations, provide a complete - list of destinations. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - - - - Gets and sets the property CustomEventData. - - Information to be added to all events that are related to this game session queue. - - - - - - - Gets and sets the property Destinations. - - A list of fleets and/or fleet aliases that can be used to fulfill game session placement - requests in the queue. Destinations are identified by either a fleet ARN or a fleet - alias ARN, and are listed in order of placement preference. When updating this list, - provide a complete list of destinations. - - - - - - Gets and sets the property FilterConfiguration. - - A list of locations where a queue is allowed to place new game sessions. Locations - are specified in the form of AWS Region codes, such as us-west-2. If - this parameter is not set, game sessions can be placed in any queue location. To remove - an existing filter configuration, pass in an empty set. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with game session queue. Queue names must be - unique within each Region. You can use either the queue ID or ARN value. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive game session placement notifications. See - - Setting up notifications for game session placement. - - - - - - Gets and sets the property PlayerLatencyPolicies. - - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver - low latency for most players in a game session. These policies ensure that no individual - player can be placed into a game with unreasonably high latency. Use multiple policies - to gradually relax latency requirements a step at a time. Multiple policies are applied - based on their maximum allowed latency, starting with the lowest value. When updating - policies, provide a complete collection of policies. - - - - - - Gets and sets the property PriorityConfiguration. - - Custom settings to use when prioritizing destinations and locations for game session - placements. This configuration replaces the FleetIQ default prioritization process. - Priority types that are not explicitly named will be automatically applied at the - end of the prioritization process. To remove an existing priority configuration, pass - in an empty set. - - - - - - Gets and sets the property TimeoutInSeconds. - - The maximum time, in seconds, that a new game session placement request remains in - the queue. When a request exceeds this time, the game session placement changes to - a TIMED_OUT status. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSessionQueue. - - An object that describes the newly updated game session queue. - - - - - - Container for the parameters to the UpdateGameSession operation. - Updates the mutable properties of a game session. - - - - To update a game session, specify the game session ID and the values you want to change. - - - - - If successful, the updated GameSession object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - - - - Gets and sets the property GameSessionId. - - A unique identifier for the game session to update. - - - - - - Gets and sets the property MaximumPlayerSessionCount. - - The maximum number of players that can be connected simultaneously to the game session. - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a game session. Session names do not need - to be unique. - - - - - - Gets and sets the property PlayerSessionCreationPolicy. - - A policy that determines whether the game session is accepting new players. - - - - - - Gets and sets the property ProtectionPolicy. - - Game session protection policy to apply to this game session only. - -
  • - - NoProtection -- The game session can be terminated during a scale-down event. - -
  • - - FullProtection -- If the game session is in an ACTIVE status, - it cannot be terminated during a scale-down event. - -
- - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property GameSession. - - The updated game session properties. - - - - - - Container for the parameters to the UpdateMatchmakingConfiguration operation. - Updates settings for a FlexMatch matchmaking configuration. These changes affect all - matches and game sessions that are created after the update. To update settings, specify - the configuration name to be updated and provide the new settings. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property AcceptanceRequired. - - A flag that indicates whether a match that was created with this configuration must - be accepted by the matched players. To require acceptance, set to TRUE. With this - option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE - to indicate when a completed potential match is waiting for player acceptance. - - - - - - Gets and sets the property AcceptanceTimeoutSeconds. - - The length of time (in seconds) to wait for players to accept a proposed match, if - acceptance is required. - - - - - - Gets and sets the property AdditionalPlayerCount. - - The number of player slots in a match to keep open for future players. For example, - if the configuration's rule set specifies a match for a single 12-person team, and - the additional player count is set to 2, only 10 players are selected for the match. - This parameter is not used if FlexMatchMode is set to STANDALONE. - - - - - - Gets and sets the property BackfillMode. - - The method that is used to backfill game sessions created with this matchmaking configuration. - Specify MANUAL when your game manages backfill requests manually or does not use the - match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill - request whenever a game session has one or more open slots. Learn more about manual - and automatic backfill in Backfill - Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property CustomEventData. - - Information to add to all events related to the matchmaking configuration. - - - - - - Gets and sets the property Description. - - A descriptive label that is associated with matchmaking configuration. - - - - - - Gets and sets the property FlexMatchMode. - - Indicates whether this matchmaking configuration is being used with GameLift hosting - or as a standalone matchmaking solution. - -
  • - - STANDALONE - FlexMatch forms matches and returns match information, including - players and team assignments, in a - MatchmakingSucceeded event. - -
  • - - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue - to start a game session for the match. - -
- - - - - Gets and sets the property GameProperties. - - A set of custom properties for a game session, formatted as key:value pairs. These - properties are passed to a game server process in the GameSession object with - a request to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used if FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionData. - - A set of custom game session properties, formatted as a single string value. This - data is passed to a game server process in the GameSession object with a request - to start a new game session (see Start - a Game Session). This information is added to the new GameSession object - that is created for a successful match. This parameter is not used if FlexMatchMode - is set to STANDALONE. - - - - - - Gets and sets the property GameSessionQueueArns. - - The Amazon Resource Name (ARN) - that is assigned to a GameLift game session queue resource and uniquely identifies - it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue - name>. Queues can be located in any Region. Queues are used to start new - GameLift-hosted game sessions for matches that are created with this matchmaking configuration. - If FlexMatchMode is set to STANDALONE, do not set this parameter. - - - - - - Gets and sets the property Name. - - A unique identifier for the matchmaking configuration to update. You can use either - the configuration name or ARN value. - - - - - - Gets and sets the property NotificationTarget. - - An SNS topic ARN that is set up to receive matchmaking notifications. See - Setting up notifications for matchmaking for more information. - - - - - - Gets and sets the property RequestTimeoutSeconds. - - The maximum duration, in seconds, that a matchmaking ticket can remain in process - before timing out. Requests that fail due to timing out can be resubmitted as needed. - - - - - - Gets and sets the property RuleSetName. - - A unique identifier for the matchmaking rule set to use with this configuration. You - can use either the rule set name or ARN value. A matchmaking configuration can only - use rule sets that are defined in the same Region. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Configuration. - - The updated matchmaking configuration. - - - - - - Container for the parameters to the UpdateRuntimeConfiguration operation. - Updates the current runtime configuration for the specified fleet, which tells GameLift - how to launch server processes on all instances in the fleet. You can update a fleet's - runtime configuration at any time after the fleet is created; it does not need to - be in ACTIVE status. - - - - To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration - with an updated set of server process configurations. - - - - If successful, the fleet's runtime configuration settings are updated. Each instance - in the fleet regularly checks for and retrieves updated runtime configurations. Instances - immediately begin complying with the new configuration by launching new server processes - or not replacing existing processes when they shut down. Updating a fleet's runtime - configuration never affects existing server processes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet to update runtime configuration for. You can use - either the fleet ID or ARN value. - - - - - - Gets and sets the property RuntimeConfiguration. - - Instructions for launching server processes on each instance in the fleet. Server - processes run either a custom game build executable or a Realtime Servers script. - The runtime configuration lists the types of server processes to run on an instance, - how to launch them, and the number of processes to run concurrently. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property RuntimeConfiguration. - - The runtime configuration currently in use by all instances in the fleet. If the update - was successful, all property changes are shown. - - - - - - Container for the parameters to the UpdateScript operation. - Updates Realtime script metadata and content. - - - - To update script metadata, specify the script ID and provide updated name and/or version - values. - - - - To update script content, provide an updated zip file by pointing to either a local - file or an Amazon S3 bucket location. You can use either method regardless of how - the original script was uploaded. Use the Version parameter to track updates - to the script. - - - - If the call is successful, the updated metadata is stored in the script record and - a revised script is uploaded to the Amazon GameLift service. Once the script is updated - and acquired by a fleet instance, the new version is used for all new game sessions. - - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - - - - Gets and sets the property Name. - - A descriptive label that is associated with a script. Script names do not need to - be unique. - - - - - - Gets and sets the property ScriptId. - - A unique identifier for the Realtime script to update. You can use either the script - ID or ARN value. - - - - - - Gets and sets the property StorageLocation. - - The location of the Amazon S3 bucket where a zipped file containing your Realtime - scripts is stored. The storage location must specify the Amazon S3 bucket name, the - zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the - Amazon S3 storage location. The S3 bucket must be in the same Region where you want - to create a new script. By default, Amazon GameLift uploads the latest version of - the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion - parameter to specify an earlier version. - - - - - - Gets and sets the property Version. - - Version information that is associated with a build or script. Version strings do - not need to be unique. - - - - - - Gets and sets the property ZipFile. - - A data object containing your Realtime scripts and dependencies as a zip file. The - zip file can have one or multiple files. Maximum size of a zip file is 5 MB. - - - - When using the AWS CLI tool to create a script, this parameter is set to the zip file - name. It must be prepended with the string "fileb://" to indicate that the file data - is a binary object. For example: --zip-file fileb://myRealtimeScript.zip. - - - - - - This is the response object from the UpdateScript operation. - - - - - Gets and sets the property Script. - - The newly created script record with a unique script ID. The new script's storage - location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 - bucket under your account, the storage location reflects the information that was - provided in the CreateScript request; (2) If the script file was uploaded from - a local zip file, the storage location reflects an S3 location controls by the Amazon - GameLift service. - - - - - - Container for the parameters to the ValidateMatchmakingRuleSet operation. - Validates the syntax of a matchmaking rule or rule set. This operation checks that - the rule set is using syntactically correct JSON and that it conforms to allowed property - expressions. To validate syntax, provide a rule set JSON string. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - - - - Gets and sets the property RuleSetBody. - - A collection of matchmaking rules to validate, formatted as a JSON string. - - - - - - Represents the returned data in response to a request operation. - - - - - Gets and sets the property Valid. - - A response indicating whether the rule set is valid. - - - - - - Represents an authorization for a VPC peering connection between the VPC for an Amazon - GameLift fleet and another VPC on an account you have access to. This authorization - must exist and be valid for the peering connection to be established. Authorizations - are valid for 24 hours after they are issued. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property CreationTime. - - Time stamp indicating when this authorization was issued. Format is a number expressed - in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property ExpirationTime. - - Time stamp indicating when this authorization expires (24 hours after issuance). Format - is a number expressed in Unix time as milliseconds (for example "1469498468.057"). - - - - - - Gets and sets the property GameLiftAwsAccountId. - - A unique identifier for the AWS account that you use to manage your GameLift fleet. - You can find your Account ID in the AWS Management Console under account settings. - - - - - - Gets and sets the property PeerVpcAwsAccountId. - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - Represents a peering connection between a VPC on one of your AWS accounts and the - VPC for your Amazon GameLift fleets. This record may be for an active peering connection - or a pending connection that has not yet been established. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - - - - Gets and sets the property FleetArn. - - The Amazon Resource Name (ARN) - associated with the GameLift fleet resource for this connection. - - - - - - Gets and sets the property FleetId. - - A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift - VPC for your fleet. - - - - - - Gets and sets the property GameLiftVpcId. - - A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. - This VPC is managed by Amazon GameLift and does not appear in your AWS account. - - - - - - Gets and sets the property IpV4CidrBlock. - - CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift - VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot - overlap or the peering connection cannot be created. - - - - - - Gets and sets the property PeerVpcId. - - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. - The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management - Console. Learn more about VPC peering in VPC - Peering with GameLift Fleets. - - - - - - Gets and sets the property Status. - - The status information about the connection. Status indicates if a connection is pending, - successful, or failed. - - - - - - Gets and sets the property VpcPeeringConnectionId. - - A unique identifier that is automatically assigned to the connection record. This - ID is referenced in VPC peering connection events, and is used when deleting a connection - with DeleteVpcPeeringConnection. - - - - - - Represents status information for a VPC peering connection. Status is associated with - a VpcPeeringConnection object. Status codes and messages are provided from - EC2 (see VpcPeeringConnectionStateReason). - Connection status information is also communicated as a fleet Event. - - - - - Gets and sets the property Code. - - Code indicating the status of a VPC peering connection. - - - - - - Gets and sets the property Message. - - Additional messaging associated with the connection status. - - - - - - Base class for DescribeFleetAttributes paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetAttributes - - - - - Base class for DescribeFleetCapacity paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetCapacity - - - - - Base class for DescribeFleetEvents paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Events - - - - - Base class for DescribeFleetLocationAttributes paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Base class for DescribeFleetUtilization paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetUtilization - - - - - Base class for DescribeGameServerInstances paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServerInstances - - - - - Base class for DescribeGameSessionDetails paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessionDetails - - - - - Base class for DescribeGameSessionQueues paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessionQueues - - - - - Base class for DescribeGameSessions paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessions - - - - - Base class for DescribeInstances paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Instances - - - - - Base class for DescribeMatchmakingConfigurations paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Configurations - - - - - Base class for DescribeMatchmakingRuleSets paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the RuleSets - - - - - Base class for DescribePlayerSessions paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the PlayerSessions - - - - - Base class for DescribeScalingPolicies paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the ScalingPolicies - - - - - Paginators for the GameLift service - - - - - Paginator for DescribeFleetAttributes operation - - - - - Paginator for DescribeFleetCapacity operation - - - - - Paginator for DescribeFleetEvents operation - - - - - Paginator for DescribeFleetLocationAttributes operation - - - - - Paginator for DescribeFleetUtilization operation - - - - - Paginator for DescribeGameServerInstances operation - - - - - Paginator for DescribeGameSessionDetails operation - - - - - Paginator for DescribeGameSessionQueues operation - - - - - Paginator for DescribeGameSessions operation - - - - - Paginator for DescribeInstances operation - - - - - Paginator for DescribeMatchmakingConfigurations operation - - - - - Paginator for DescribeMatchmakingRuleSets operation - - - - - Paginator for DescribePlayerSessions operation - - - - - Paginator for DescribeScalingPolicies operation - - - - - Paginator for ListAliases operation - - - - - Paginator for ListBuilds operation - - - - - Paginator for ListFleets operation - - - - - Paginator for ListGameServerGroups operation - - - - - Paginator for ListGameServers operation - - - - - Paginator for ListScripts operation - - - - - Paginator for SearchGameSessions operation - - - - - Paginator for the DescribeFleetAttributes operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetAttributes - - - - - Paginator for the DescribeFleetCapacity operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetCapacity - - - - - Paginator for the DescribeFleetEvents operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Events - - - - - Paginator for the DescribeFleetLocationAttributes operation - - - - - Enumerable containing all full responses for the operation - - - - - Paginator for the DescribeFleetUtilization operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetUtilization - - - - - Paginator for the DescribeGameServerInstances operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServerInstances - - - - - Paginator for the DescribeGameSessionDetails operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessionDetails - - - - - Paginator for the DescribeGameSessionQueues operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessionQueues - - - - - Paginator for the DescribeGameSessions operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessions - - - - - Paginator for the DescribeInstances operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Instances - - - - - Paginator for the DescribeMatchmakingConfigurations operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Configurations - - - - - Paginator for the DescribeMatchmakingRuleSets operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the RuleSets - - - - - Paginator for the DescribePlayerSessions operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the PlayerSessions - - - - - Paginator for the DescribeScalingPolicies operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the ScalingPolicies - - - - - Paginators for the GameLift service - - - - - Paginator for DescribeFleetAttributes operation - - - - - Paginator for DescribeFleetCapacity operation - - - - - Paginator for DescribeFleetEvents operation - - - - - Paginator for DescribeFleetLocationAttributes operation - - - - - Paginator for DescribeFleetUtilization operation - - - - - Paginator for DescribeGameServerInstances operation - - - - - Paginator for DescribeGameSessionDetails operation - - - - - Paginator for DescribeGameSessionQueues operation - - - - - Paginator for DescribeGameSessions operation - - - - - Paginator for DescribeInstances operation - - - - - Paginator for DescribeMatchmakingConfigurations operation - - - - - Paginator for DescribeMatchmakingRuleSets operation - - - - - Paginator for DescribePlayerSessions operation - - - - - Paginator for DescribeScalingPolicies operation - - - - - Paginator for ListAliases operation - - - - - Paginator for ListBuilds operation - - - - - Paginator for ListFleets operation - - - - - Paginator for ListGameServerGroups operation - - - - - Paginator for ListGameServers operation - - - - - Paginator for ListScripts operation - - - - - Paginator for SearchGameSessions operation - - - - - Paginator for the ListAliases operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Aliases - - - - - Paginator for the ListBuilds operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Builds - - - - - Paginator for the ListFleets operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetIds - - - - - Paginator for the ListGameServerGroups operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServerGroups - - - - - Paginator for the ListGameServers operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServers - - - - - Paginator for the ListScripts operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Scripts - - - - - Paginator for the SearchGameSessions operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessions - - - - - Base class for ListAliases paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Aliases - - - - - Base class for ListBuilds paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Builds - - - - - Base class for ListFleets paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the FleetIds - - - - - Base class for ListGameServerGroups paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServerGroups - - - - - Base class for ListGameServers paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameServers - - - - - Base class for ListScripts paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Scripts - - - - - Base class for SearchGameSessions paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the GameSessions - - - - - Configuration for accessing Amazon GameLift service - - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Common exception for the GameLift service. - - - - - Construct instance of AmazonGameLiftException - - - - - - Construct instance of AmazonGameLiftException - - - - - - - Construct instance of AmazonGameLiftException - - - - - - Construct instance of AmazonGameLiftException - - - - - - - - - - Construct instance of AmazonGameLiftException - - - - - - - - - - - Constructs a new instance of the AmazonGameLiftException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Service metadata for Amazon GameLift service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Base class for GameLift operation requests. - - - - - Constants used for properties of type AcceptanceType. - - - - - Constant ACCEPT for AcceptanceType - - - - - Constant REJECT for AcceptanceType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type BackfillMode. - - - - - Constant AUTOMATIC for BackfillMode - - - - - Constant MANUAL for BackfillMode - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type BalancingStrategy. - - - - - Constant ON_DEMAND_ONLY for BalancingStrategy - - - - - Constant SPOT_ONLY for BalancingStrategy - - - - - Constant SPOT_PREFERRED for BalancingStrategy - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type BuildStatus. - - - - - Constant FAILED for BuildStatus - - - - - Constant INITIALIZED for BuildStatus - - - - - Constant READY for BuildStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type CertificateType. - - - - - Constant DISABLED for CertificateType - - - - - Constant GENERATED for CertificateType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ComparisonOperatorType. - - - - - Constant GreaterThanOrEqualToThreshold for ComparisonOperatorType - - - - - Constant GreaterThanThreshold for ComparisonOperatorType - - - - - Constant LessThanOrEqualToThreshold for ComparisonOperatorType - - - - - Constant LessThanThreshold for ComparisonOperatorType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EC2InstanceType. - - - - - Constant C32xlarge for EC2InstanceType - - - - - Constant C34xlarge for EC2InstanceType - - - - - Constant C38xlarge for EC2InstanceType - - - - - Constant C3Large for EC2InstanceType - - - - - Constant C3Xlarge for EC2InstanceType - - - - - Constant C42xlarge for EC2InstanceType - - - - - Constant C44xlarge for EC2InstanceType - - - - - Constant C48xlarge for EC2InstanceType - - - - - Constant C4Large for EC2InstanceType - - - - - Constant C4Xlarge for EC2InstanceType - - - - - Constant C512xlarge for EC2InstanceType - - - - - Constant C518xlarge for EC2InstanceType - - - - - Constant C524xlarge for EC2InstanceType - - - - - Constant C52xlarge for EC2InstanceType - - - - - Constant C54xlarge for EC2InstanceType - - - - - Constant C59xlarge for EC2InstanceType - - - - - Constant C5a12xlarge for EC2InstanceType - - - - - Constant C5a16xlarge for EC2InstanceType - - - - - Constant C5a24xlarge for EC2InstanceType - - - - - Constant C5a2xlarge for EC2InstanceType - - - - - Constant C5a4xlarge for EC2InstanceType - - - - - Constant C5a8xlarge for EC2InstanceType - - - - - Constant C5aLarge for EC2InstanceType - - - - - Constant C5aXlarge for EC2InstanceType - - - - - Constant C5Large for EC2InstanceType - - - - - Constant C5Xlarge for EC2InstanceType - - - - - Constant M32xlarge for EC2InstanceType - - - - - Constant M3Large for EC2InstanceType - - - - - Constant M3Medium for EC2InstanceType - - - - - Constant M3Xlarge for EC2InstanceType - - - - - Constant M410xlarge for EC2InstanceType - - - - - Constant M42xlarge for EC2InstanceType - - - - - Constant M44xlarge for EC2InstanceType - - - - - Constant M4Large for EC2InstanceType - - - - - Constant M4Xlarge for EC2InstanceType - - - - - Constant M512xlarge for EC2InstanceType - - - - - Constant M516xlarge for EC2InstanceType - - - - - Constant M524xlarge for EC2InstanceType - - - - - Constant M52xlarge for EC2InstanceType - - - - - Constant M54xlarge for EC2InstanceType - - - - - Constant M58xlarge for EC2InstanceType - - - - - Constant M5a12xlarge for EC2InstanceType - - - - - Constant M5a16xlarge for EC2InstanceType - - - - - Constant M5a24xlarge for EC2InstanceType - - - - - Constant M5a2xlarge for EC2InstanceType - - - - - Constant M5a4xlarge for EC2InstanceType - - - - - Constant M5a8xlarge for EC2InstanceType - - - - - Constant M5aLarge for EC2InstanceType - - - - - Constant M5aXlarge for EC2InstanceType - - - - - Constant M5Large for EC2InstanceType - - - - - Constant M5Xlarge for EC2InstanceType - - - - - Constant R32xlarge for EC2InstanceType - - - - - Constant R34xlarge for EC2InstanceType - - - - - Constant R38xlarge for EC2InstanceType - - - - - Constant R3Large for EC2InstanceType - - - - - Constant R3Xlarge for EC2InstanceType - - - - - Constant R416xlarge for EC2InstanceType - - - - - Constant R42xlarge for EC2InstanceType - - - - - Constant R44xlarge for EC2InstanceType - - - - - Constant R48xlarge for EC2InstanceType - - - - - Constant R4Large for EC2InstanceType - - - - - Constant R4Xlarge for EC2InstanceType - - - - - Constant R512xlarge for EC2InstanceType - - - - - Constant R516xlarge for EC2InstanceType - - - - - Constant R524xlarge for EC2InstanceType - - - - - Constant R52xlarge for EC2InstanceType - - - - - Constant R54xlarge for EC2InstanceType - - - - - Constant R58xlarge for EC2InstanceType - - - - - Constant R5a12xlarge for EC2InstanceType - - - - - Constant R5a16xlarge for EC2InstanceType - - - - - Constant R5a24xlarge for EC2InstanceType - - - - - Constant R5a2xlarge for EC2InstanceType - - - - - Constant R5a4xlarge for EC2InstanceType - - - - - Constant R5a8xlarge for EC2InstanceType - - - - - Constant R5aLarge for EC2InstanceType - - - - - Constant R5aXlarge for EC2InstanceType - - - - - Constant R5Large for EC2InstanceType - - - - - Constant R5Xlarge for EC2InstanceType - - - - - Constant T2Large for EC2InstanceType - - - - - Constant T2Medium for EC2InstanceType - - - - - Constant T2Micro for EC2InstanceType - - - - - Constant T2Small for EC2InstanceType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type EventCode. - - - - - Constant FLEET_ACTIVATION_FAILED for EventCode - - - - - Constant FLEET_ACTIVATION_FAILED_NO_INSTANCES for EventCode - - - - - Constant FLEET_BINARY_DOWNLOAD_FAILED for EventCode - - - - - Constant FLEET_CREATED for EventCode - - - - - Constant FLEET_CREATION_EXTRACTING_BUILD for EventCode - - - - - Constant FLEET_CREATION_RUNNING_INSTALLER for EventCode - - - - - Constant FLEET_CREATION_VALIDATING_RUNTIME_CONFIG for EventCode - - - - - Constant FLEET_DELETED for EventCode - - - - - Constant FLEET_INITIALIZATION_FAILED for EventCode - - - - - Constant FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED for EventCode - - - - - Constant FLEET_SCALING_EVENT for EventCode - - - - - Constant FLEET_STATE_ACTIVATING for EventCode - - - - - Constant FLEET_STATE_ACTIVE for EventCode - - - - - Constant FLEET_STATE_BUILDING for EventCode - - - - - Constant FLEET_STATE_DOWNLOADING for EventCode - - - - - Constant FLEET_STATE_ERROR for EventCode - - - - - Constant FLEET_STATE_VALIDATING for EventCode - - - - - Constant FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE for EventCode - - - - - Constant FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND for EventCode - - - - - Constant FLEET_VALIDATION_TIMED_OUT for EventCode - - - - - Constant FLEET_VPC_PEERING_DELETED for EventCode - - - - - Constant FLEET_VPC_PEERING_FAILED for EventCode - - - - - Constant FLEET_VPC_PEERING_SUCCEEDED for EventCode - - - - - Constant GAME_SESSION_ACTIVATION_TIMEOUT for EventCode - - - - - Constant GENERIC_EVENT for EventCode - - - - - Constant INSTANCE_INTERRUPTED for EventCode - - - - - Constant SERVER_PROCESS_CRASHED for EventCode - - - - - Constant SERVER_PROCESS_FORCE_TERMINATED for EventCode - - - - - Constant SERVER_PROCESS_INVALID_PATH for EventCode - - - - - Constant SERVER_PROCESS_PROCESS_EXIT_TIMEOUT for EventCode - - - - - Constant SERVER_PROCESS_PROCESS_READY_TIMEOUT for EventCode - - - - - Constant SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT for EventCode - - - - - Constant SERVER_PROCESS_TERMINATED_UNHEALTHY for EventCode - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type FleetAction. - - - - - Constant AUTO_SCALING for FleetAction - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type FleetStatus. - - - - - Constant ACTIVATING for FleetStatus - - - - - Constant ACTIVE for FleetStatus - - - - - Constant BUILDING for FleetStatus - - - - - Constant DELETING for FleetStatus - - - - - Constant DOWNLOADING for FleetStatus - - - - - Constant ERROR for FleetStatus - - - - - Constant NEW for FleetStatus - - - - - Constant TERMINATED for FleetStatus - - - - - Constant VALIDATING for FleetStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type FleetType. - - - - - Constant ON_DEMAND for FleetType - - - - - Constant SPOT for FleetType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type FlexMatchMode. - - - - - Constant STANDALONE for FlexMatchMode - - - - - Constant WITH_QUEUE for FlexMatchMode - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerClaimStatus. - - - - - Constant CLAIMED for GameServerClaimStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerGroupAction. - - - - - Constant REPLACE_INSTANCE_TYPES for GameServerGroupAction - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerGroupDeleteOption. - - - - - Constant FORCE_DELETE for GameServerGroupDeleteOption - - - - - Constant RETAIN for GameServerGroupDeleteOption - - - - - Constant SAFE_DELETE for GameServerGroupDeleteOption - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerGroupInstanceType. - - - - - Constant C42xlarge for GameServerGroupInstanceType - - - - - Constant C44xlarge for GameServerGroupInstanceType - - - - - Constant C48xlarge for GameServerGroupInstanceType - - - - - Constant C4Large for GameServerGroupInstanceType - - - - - Constant C4Xlarge for GameServerGroupInstanceType - - - - - Constant C512xlarge for GameServerGroupInstanceType - - - - - Constant C518xlarge for GameServerGroupInstanceType - - - - - Constant C524xlarge for GameServerGroupInstanceType - - - - - Constant C52xlarge for GameServerGroupInstanceType - - - - - Constant C54xlarge for GameServerGroupInstanceType - - - - - Constant C59xlarge for GameServerGroupInstanceType - - - - - Constant C5a12xlarge for GameServerGroupInstanceType - - - - - Constant C5a16xlarge for GameServerGroupInstanceType - - - - - Constant C5a24xlarge for GameServerGroupInstanceType - - - - - Constant C5a2xlarge for GameServerGroupInstanceType - - - - - Constant C5a4xlarge for GameServerGroupInstanceType - - - - - Constant C5a8xlarge for GameServerGroupInstanceType - - - - - Constant C5aLarge for GameServerGroupInstanceType - - - - - Constant C5aXlarge for GameServerGroupInstanceType - - - - - Constant C5Large for GameServerGroupInstanceType - - - - - Constant C5Xlarge for GameServerGroupInstanceType - - - - - Constant M410xlarge for GameServerGroupInstanceType - - - - - Constant M42xlarge for GameServerGroupInstanceType - - - - - Constant M44xlarge for GameServerGroupInstanceType - - - - - Constant M4Large for GameServerGroupInstanceType - - - - - Constant M4Xlarge for GameServerGroupInstanceType - - - - - Constant M512xlarge for GameServerGroupInstanceType - - - - - Constant M516xlarge for GameServerGroupInstanceType - - - - - Constant M524xlarge for GameServerGroupInstanceType - - - - - Constant M52xlarge for GameServerGroupInstanceType - - - - - Constant M54xlarge for GameServerGroupInstanceType - - - - - Constant M58xlarge for GameServerGroupInstanceType - - - - - Constant M5a12xlarge for GameServerGroupInstanceType - - - - - Constant M5a16xlarge for GameServerGroupInstanceType - - - - - Constant M5a24xlarge for GameServerGroupInstanceType - - - - - Constant M5a2xlarge for GameServerGroupInstanceType - - - - - Constant M5a4xlarge for GameServerGroupInstanceType - - - - - Constant M5a8xlarge for GameServerGroupInstanceType - - - - - Constant M5aLarge for GameServerGroupInstanceType - - - - - Constant M5aXlarge for GameServerGroupInstanceType - - - - - Constant M5Large for GameServerGroupInstanceType - - - - - Constant M5Xlarge for GameServerGroupInstanceType - - - - - Constant R416xlarge for GameServerGroupInstanceType - - - - - Constant R42xlarge for GameServerGroupInstanceType - - - - - Constant R44xlarge for GameServerGroupInstanceType - - - - - Constant R48xlarge for GameServerGroupInstanceType - - - - - Constant R4Large for GameServerGroupInstanceType - - - - - Constant R4Xlarge for GameServerGroupInstanceType - - - - - Constant R512xlarge for GameServerGroupInstanceType - - - - - Constant R516xlarge for GameServerGroupInstanceType - - - - - Constant R524xlarge for GameServerGroupInstanceType - - - - - Constant R52xlarge for GameServerGroupInstanceType - - - - - Constant R54xlarge for GameServerGroupInstanceType - - - - - Constant R58xlarge for GameServerGroupInstanceType - - - - - Constant R5a12xlarge for GameServerGroupInstanceType - - - - - Constant R5a16xlarge for GameServerGroupInstanceType - - - - - Constant R5a24xlarge for GameServerGroupInstanceType - - - - - Constant R5a2xlarge for GameServerGroupInstanceType - - - - - Constant R5a4xlarge for GameServerGroupInstanceType - - - - - Constant R5a8xlarge for GameServerGroupInstanceType - - - - - Constant R5aLarge for GameServerGroupInstanceType - - - - - Constant R5aXlarge for GameServerGroupInstanceType - - - - - Constant R5Large for GameServerGroupInstanceType - - - - - Constant R5Xlarge for GameServerGroupInstanceType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerGroupStatus. - - - - - Constant ACTIVATING for GameServerGroupStatus - - - - - Constant ACTIVE for GameServerGroupStatus - - - - - Constant DELETE_SCHEDULED for GameServerGroupStatus - - - - - Constant DELETED for GameServerGroupStatus - - - - - Constant DELETING for GameServerGroupStatus - - - - - Constant ERROR for GameServerGroupStatus - - - - - Constant NEW for GameServerGroupStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerHealthCheck. - - - - - Constant HEALTHY for GameServerHealthCheck - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerInstanceStatus. - - - - - Constant ACTIVE for GameServerInstanceStatus - - - - - Constant DRAINING for GameServerInstanceStatus - - - - - Constant SPOT_TERMINATING for GameServerInstanceStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerProtectionPolicy. - - - - - Constant FULL_PROTECTION for GameServerProtectionPolicy - - - - - Constant NO_PROTECTION for GameServerProtectionPolicy - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameServerUtilizationStatus. - - - - - Constant AVAILABLE for GameServerUtilizationStatus - - - - - Constant UTILIZED for GameServerUtilizationStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameSessionPlacementState. - - - - - Constant CANCELLED for GameSessionPlacementState - - - - - Constant FAILED for GameSessionPlacementState - - - - - Constant FULFILLED for GameSessionPlacementState - - - - - Constant PENDING for GameSessionPlacementState - - - - - Constant TIMED_OUT for GameSessionPlacementState - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameSessionStatus. - - - - - Constant ACTIVATING for GameSessionStatus - - - - - Constant ACTIVE for GameSessionStatus - - - - - Constant ERROR for GameSessionStatus - - - - - Constant TERMINATED for GameSessionStatus - - - - - Constant TERMINATING for GameSessionStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type GameSessionStatusReason. - - - - - Constant INTERRUPTED for GameSessionStatusReason - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type InstanceStatus. - - - - - Constant ACTIVE for InstanceStatus - - - - - Constant PENDING for InstanceStatus - - - - - Constant TERMINATING for InstanceStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type IpProtocol. - - - - - Constant TCP for IpProtocol - - - - - Constant UDP for IpProtocol - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type LocationUpdateStatus. - - - - - Constant PENDING_UPDATE for LocationUpdateStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type MatchmakingConfigurationStatus. - - - - - Constant CANCELLED for MatchmakingConfigurationStatus - - - - - Constant COMPLETED for MatchmakingConfigurationStatus - - - - - Constant FAILED for MatchmakingConfigurationStatus - - - - - Constant PLACING for MatchmakingConfigurationStatus - - - - - Constant QUEUED for MatchmakingConfigurationStatus - - - - - Constant REQUIRES_ACCEPTANCE for MatchmakingConfigurationStatus - - - - - Constant SEARCHING for MatchmakingConfigurationStatus - - - - - Constant TIMED_OUT for MatchmakingConfigurationStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type MetricName. - - - - - Constant ActivatingGameSessions for MetricName - - - - - Constant ActiveGameSessions for MetricName - - - - - Constant ActiveInstances for MetricName - - - - - Constant AvailableGameSessions for MetricName - - - - - Constant AvailablePlayerSessions for MetricName - - - - - Constant CurrentPlayerSessions for MetricName - - - - - Constant IdleInstances for MetricName - - - - - Constant PercentAvailableGameSessions for MetricName - - - - - Constant PercentIdleInstances for MetricName - - - - - Constant QueueDepth for MetricName - - - - - Constant WaitTime for MetricName - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type OperatingSystem. - - - - - Constant AMAZON_LINUX for OperatingSystem - - - - - Constant AMAZON_LINUX_2 for OperatingSystem - - - - - Constant WINDOWS_2012 for OperatingSystem - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PlayerSessionCreationPolicy. - - - - - Constant ACCEPT_ALL for PlayerSessionCreationPolicy - - - - - Constant DENY_ALL for PlayerSessionCreationPolicy - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PlayerSessionStatus. - - - - - Constant ACTIVE for PlayerSessionStatus - - - - - Constant COMPLETED for PlayerSessionStatus - - - - - Constant RESERVED for PlayerSessionStatus - - - - - Constant TIMEDOUT for PlayerSessionStatus - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PolicyType. - - - - - Constant RuleBased for PolicyType - - - - - Constant TargetBased for PolicyType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type PriorityType. - - - - - Constant COST for PriorityType - - - - - Constant DESTINATION for PriorityType - - - - - Constant LATENCY for PriorityType - - - - - Constant LOCATION for PriorityType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ProtectionPolicy. - - - - - Constant FullProtection for ProtectionPolicy - - - - - Constant NoProtection for ProtectionPolicy - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type RoutingStrategyType. - - - - - Constant SIMPLE for RoutingStrategyType - - - - - Constant TERMINAL for RoutingStrategyType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ScalingAdjustmentType. - - - - - Constant ChangeInCapacity for ScalingAdjustmentType - - - - - Constant ExactCapacity for ScalingAdjustmentType - - - - - Constant PercentChangeInCapacity for ScalingAdjustmentType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type ScalingStatusType. - - - - - Constant ACTIVE for ScalingStatusType - - - - - Constant DELETE_REQUESTED for ScalingStatusType - - - - - Constant DELETED for ScalingStatusType - - - - - Constant DELETING for ScalingStatusType - - - - - Constant ERROR for ScalingStatusType - - - - - Constant UPDATE_REQUESTED for ScalingStatusType - - - - - Constant UPDATING for ScalingStatusType - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Constants used for properties of type SortOrder. - - - - - Constant ASCENDING for SortOrder - - - - - Constant DESCENDING for SortOrder - - - - - This constant constructor does not need to be called if the constant - you are attempting to use is already defined as a static instance of - this class. - This constructor should be used to construct constants that are not - defined as statics, for instance if attempting to use a feature that is - newer than the current version of the SDK. - - - - - Finds the constant for the unique value. - - The unique value for the constant - The constant for the unique value - - - - Utility method to convert strings to the constant class. - - The string value to convert to the constant class. - - - - - Implementation for accessing GameLift - - Amazon GameLift Service - - GameLift provides solutions for hosting session-based multiplayer game servers in - the cloud, including tools for deploying, operating, and scaling game servers. Built - on AWS global computing infrastructure, GameLift helps you deliver high-performance, - high-reliability, low-cost game servers while dynamically scaling your resource usage - to meet player demand. - - - - About GameLift solutions - - - - Get more information on these GameLift solutions in the GameLift - Developer Guide. - -
  • - - GameLift managed hosting -- GameLift offers a fully managed service to set up and - maintain computing machines for hosting, manage game session and player session life - cycle, and handle security, storage, and performance tracking. You can use automatic - scaling tools to balance player demand and hosting costs, configure your game session - management to minimize player latency, and add FlexMatch for matchmaking. - -
  • - - Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly - configure and set up ready-to-go game servers for your game. Realtime Servers provides - a game server framework with core GameLift infrastructure already built in. Then use - the full range of GameLift managed hosting features, including FlexMatch, for your - game. - -
  • - - GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your - games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations - for game hosting, including boosting the viability of low-cost Spot Instances gaming. - For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services. - -
  • - - GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is - a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated - with GameLift managed hosting or incorporate FlexMatch as a standalone service into - your own hosting solution. - -
- - About this API Reference - - - - This reference guide describes the low-level service API for Amazon GameLift. With - each topic in this guide, you can find links to language-specific SDK guides and the - AWS CLI reference. Useful links: - - - - - - - Paginators for the service - - - - - Constructs AmazonGameLiftClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonGameLiftClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonGameLiftClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonGameLiftClient Configuration Object - - - - Constructs AmazonGameLiftClient with AWS Credentials - - AWS Credentials - - - - Constructs AmazonGameLiftClient with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonGameLiftClient with AWS Credentials and an - AmazonGameLiftClient Configuration object. - - AWS Credentials - The AmazonGameLiftClient Configuration Object - - - - Constructs AmazonGameLiftClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonGameLiftClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonGameLiftClient with AWS Access Key ID, AWS Secret Key and an - AmazonGameLiftClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonGameLiftClient Configuration Object - - - - Constructs AmazonGameLiftClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonGameLiftClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonGameLiftClient with AWS Access Key ID, AWS Secret Key and an - AmazonGameLiftClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonGameLiftClient Configuration Object - - - - Creates the signer for the service. - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking - configuration may require player acceptance; if so, then matches built with that configuration - cannot be completed unless all players accept the proposed match within a specified - time limit. - - - - When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - your game to get acceptance from all players in the ticket. Acceptances are only valid - for tickets when they are in this status; all other acceptances result in an error. - - - - To register acceptance, specify the ticket ID, a response, and one or more players. - Once all players have registered acceptance, the matchmaking tickets advance to status - PLACING, where a new game session is created for the match. - - - - If any player rejects the match, or if acceptances are not received before a specified - timeout, the proposed match is dropped. The matchmaking tickets are then handled in - one of two ways: For tickets where one or more players rejected the match, the ticket - status is returned to SEARCHING to find a new match. For tickets where - one or more players failed to respond, the ticket status is set to CANCELLED, - and processing is terminated. A new matchmaking request for these players can be submitted - as needed. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - FlexMatch events (reference) - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the AcceptMatch service method. - - The response from the AcceptMatch service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for AcceptMatch Operation - - - - Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking - configuration may require player acceptance; if so, then matches built with that configuration - cannot be completed unless all players accept the proposed match within a specified - time limit. - - - - When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - your game to get acceptance from all players in the ticket. Acceptances are only valid - for tickets when they are in this status; all other acceptances result in an error. - - - - To register acceptance, specify the ticket ID, a response, and one or more players. - Once all players have registered acceptance, the matchmaking tickets advance to status - PLACING, where a new game session is created for the match. - - - - If any player rejects the match, or if acceptances are not received before a specified - timeout, the proposed match is dropped. The matchmaking tickets are then handled in - one of two ways: For tickets where one or more players rejected the match, the ticket - status is returned to SEARCHING to find a new match. For tickets where - one or more players failed to respond, the ticket status is set to CANCELLED, - and processing is terminated. A new matchmaking request for these players can be submitted - as needed. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - FlexMatch events (reference) - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the AcceptMatch service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AcceptMatch service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for AcceptMatch Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Locates an available game server and temporarily reserves it to host gameplay and - players. This operation is called from a game client or client service (such as a - matchmaker) to request hosting resources for a new game session. In response, GameLift - FleetIQ locates an available game server, places it in CLAIMED status - for 60 seconds, and returns connection information that players can use to connect - to the game server. - - - - To claim a game server, identify a game server group. You can also specify a game - server ID, although this approach bypasses GameLift FleetIQ placement optimization. - Optionally, include game data to pass to the game server at the start of a game session, - such as a game map or player information. - - - - When a game server is successfully claimed, connection information is returned. A - claimed game server's utilization status remains AVAILABLE while the - claim status is set to CLAIMED for up to 60 seconds. This time period - gives the game server time to update its status to UTILIZED (using UpdateGameServer) - once players join. If the game server's status is not updated within 60 seconds, the - game server reverts to unclaimed status and is available to be claimed by another - request. The claim time period is a fixed value and is not configurable. - - - - If you try to claim a specific game server, this request will fail in the following - cases: - -
  • - - If the game server utilization status is UTILIZED. - -
  • - - If the game server claim status is CLAIMED. - -
- - When claiming a specific game server, this request will succeed even if the game server - is running on an instance in DRAINING status. To avoid this, first check - the instance status by calling DescribeGameServerInstances. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ClaimGameServer service method. - - The response from the ClaimGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The specified game server group has no available game servers to fulfill a ClaimGameServer - request. Clients can retry such requests immediately or after a waiting period. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ClaimGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Locates an available game server and temporarily reserves it to host gameplay and - players. This operation is called from a game client or client service (such as a - matchmaker) to request hosting resources for a new game session. In response, GameLift - FleetIQ locates an available game server, places it in CLAIMED status - for 60 seconds, and returns connection information that players can use to connect - to the game server. - - - - To claim a game server, identify a game server group. You can also specify a game - server ID, although this approach bypasses GameLift FleetIQ placement optimization. - Optionally, include game data to pass to the game server at the start of a game session, - such as a game map or player information. - - - - When a game server is successfully claimed, connection information is returned. A - claimed game server's utilization status remains AVAILABLE while the - claim status is set to CLAIMED for up to 60 seconds. This time period - gives the game server time to update its status to UTILIZED (using UpdateGameServer) - once players join. If the game server's status is not updated within 60 seconds, the - game server reverts to unclaimed status and is available to be claimed by another - request. The claim time period is a fixed value and is not configurable. - - - - If you try to claim a specific game server, this request will fail in the following - cases: - -
  • - - If the game server utilization status is UTILIZED. - -
  • - - If the game server claim status is CLAIMED. - -
- - When claiming a specific game server, this request will succeed even if the game server - is running on an instance in DRAINING status. To avoid this, first check - the instance status by calling DescribeGameServerInstances. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ClaimGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ClaimGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The specified game server group has no available game servers to fulfill a ClaimGameServer - request. Clients can retry such requests immediately or after a waiting period. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ClaimGameServer Operation - - - - Creates an alias for a fleet. In most situations, you can use an alias ID in place - of a fleet ID. An alias provides a level of abstraction for a fleet that is useful - when redirecting player traffic from one fleet to another, such as when updating your - game build. - - - - Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. - A simple alias points to an active fleet. A terminal alias is used to display messaging - or link to a URL instead of routing players to an active fleet. For example, you might - use a terminal alias when a game version is no longer supported and you want to direct - players to an upgrade site. - - - - To create a fleet alias, specify an alias name, routing strategy, and optional description. - Each simple alias can point to only one fleet, but a fleet can have multiple aliases. - If successful, a new alias record is returned, including an alias ID and an ARN. You - can reassign an alias to another fleet by calling UpdateAlias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the CreateAlias service method. - - The response from the CreateAlias service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateAlias Operation - - - - Creates an alias for a fleet. In most situations, you can use an alias ID in place - of a fleet ID. An alias provides a level of abstraction for a fleet that is useful - when redirecting player traffic from one fleet to another, such as when updating your - game build. - - - - Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. - A simple alias points to an active fleet. A terminal alias is used to display messaging - or link to a URL instead of routing players to an active fleet. For example, you might - use a terminal alias when a game version is no longer supported and you want to direct - players to an upgrade site. - - - - To create a fleet alias, specify an alias name, routing strategy, and optional description. - Each simple alias can point to only one fleet, but a fleet can have multiple aliases. - If successful, a new alias record is returned, including an alias ID and an ARN. You - can reassign an alias to another fleet by calling UpdateAlias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the CreateAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateAlias service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateAlias Operation - - - - Creates a new Amazon GameLift build resource for your game server binary files. Game - server binaries must be combined into a zip file for use with Amazon GameLift. - - - - When setting up a new game build for GameLift, we recommend using the AWS CLI command - upload-build - . This helper command combines two tasks: (1) it uploads your build files from - a file directory to a GameLift Amazon S3 location, and (2) it creates a new build - resource. - - - - The CreateBuild operation can used in the following scenarios: - -
  • - - To create a new game build with build files that are in an Amazon S3 location under - an AWS account that you control. To use this option, you must first give Amazon GameLift - access to the Amazon S3 bucket. With permissions in place, call CreateBuild - and specify a build name, operating system, and the Amazon S3 storage location of - your game build. - -
  • - - To directly upload your build files to a GameLift Amazon S3 location. To use this - option, first call CreateBuild and specify a build name and operating - system. This operation creates a new build resource and also returns an Amazon S3 - location with temporary access credentials. Use the credentials to manually upload - your build files to the specified Amazon S3 location. For more information, see Uploading - Objects in the Amazon S3 Developer Guide. Build files can be uploaded to - the GameLift Amazon S3 location once only; that can't be updated. - -
- - If successful, this operation creates a new build resource with a unique build ID - and places it in INITIALIZED status. A build must be in READY - status before you can create fleets with it. - - - - Learn more - - - - Uploading - Your Game - - - - - Create a Build with Files in Amazon S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the CreateBuild service method. - - The response from the CreateBuild service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateBuild Operation - - - - Creates a new Amazon GameLift build resource for your game server binary files. Game - server binaries must be combined into a zip file for use with Amazon GameLift. - - - - When setting up a new game build for GameLift, we recommend using the AWS CLI command - upload-build - . This helper command combines two tasks: (1) it uploads your build files from - a file directory to a GameLift Amazon S3 location, and (2) it creates a new build - resource. - - - - The CreateBuild operation can used in the following scenarios: - -
  • - - To create a new game build with build files that are in an Amazon S3 location under - an AWS account that you control. To use this option, you must first give Amazon GameLift - access to the Amazon S3 bucket. With permissions in place, call CreateBuild - and specify a build name, operating system, and the Amazon S3 storage location of - your game build. - -
  • - - To directly upload your build files to a GameLift Amazon S3 location. To use this - option, first call CreateBuild and specify a build name and operating - system. This operation creates a new build resource and also returns an Amazon S3 - location with temporary access credentials. Use the credentials to manually upload - your build files to the specified Amazon S3 location. For more information, see Uploading - Objects in the Amazon S3 Developer Guide. Build files can be uploaded to - the GameLift Amazon S3 location once only; that can't be updated. - -
- - If successful, this operation creates a new build resource with a unique build ID - and places it in INITIALIZED status. A build must be in READY - status before you can create fleets with it. - - - - Learn more - - - - Uploading - Your Game - - - - - Create a Build with Files in Amazon S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the CreateBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateBuild service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateBuild Operation - - - - Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your - custom game server or Realtime Servers. Use this operation to configure the computing - resources for your fleet and provide instructions for running game servers on each - instance. - - - - Most GameLift fleets can deploy instances to multiple locations, including the home - Region (where the fleet is created) and an optional set of remote locations. Fleets - that are created in the following AWS Regions support multiple locations: us-east-1 - (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets - that are created in other GameLift Regions can deploy instances in the fleet's home - Region only. All fleet instances use the same configuration regardless of location; - however, you can adjust capacity settings and turn auto-scaling on/off for each location. - - - - To create a fleet, choose the hardware for your instances, specify a game server build - or Realtime script to deploy, and provide a runtime configuration to direct GameLift - how to start and run game servers on each instance in the fleet. Set permissions for - inbound traffic to your game servers, and enable optional features as needed. When - creating a multi-location fleet, provide a list of additional remote locations. - - - - If successful, this operation creates a new Fleet resource and places it in NEW - status, which prompts GameLift to initiate the fleet - creation workflow. You can track fleet creation by checking fleet status using - DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by - monitoring fleet creation events using DescribeFleetEvents. As soon as the - fleet status changes to ACTIVE, you can enable automatic scaling for - the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. - When the status of each remote location reaches ACTIVE, you can set capacity - by location using UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Debug - fleet creation issues - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleet service method. - - The response from the CreateFleet service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleet Operation - - - - Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your - custom game server or Realtime Servers. Use this operation to configure the computing - resources for your fleet and provide instructions for running game servers on each - instance. - - - - Most GameLift fleets can deploy instances to multiple locations, including the home - Region (where the fleet is created) and an optional set of remote locations. Fleets - that are created in the following AWS Regions support multiple locations: us-east-1 - (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets - that are created in other GameLift Regions can deploy instances in the fleet's home - Region only. All fleet instances use the same configuration regardless of location; - however, you can adjust capacity settings and turn auto-scaling on/off for each location. - - - - To create a fleet, choose the hardware for your instances, specify a game server build - or Realtime script to deploy, and provide a runtime configuration to direct GameLift - how to start and run game servers on each instance in the fleet. Set permissions for - inbound traffic to your game servers, and enable optional features as needed. When - creating a multi-location fleet, provide a list of additional remote locations. - - - - If successful, this operation creates a new Fleet resource and places it in NEW - status, which prompts GameLift to initiate the fleet - creation workflow. You can track fleet creation by checking fleet status using - DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by - monitoring fleet creation events using DescribeFleetEvents. As soon as the - fleet status changes to ACTIVE, you can enable automatic scaling for - the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. - When the status of each remote location reaches ACTIVE, you can set capacity - by location using UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Debug - fleet creation issues - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateFleet service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleet Operation - - - - Adds remote locations to a fleet and begins populating the new locations with EC2 - instances. The new instances conform to the fleet's instance type, auto-scaling, and - other configuration settings. - - - - This operation cannot be used with fleets that don't support remote locations. Fleets - can have multiple locations only if they reside in AWS Regions that support this feature - (see CreateFleet for the complete list) and were created after the feature - was released in March 2021. - - - - To add fleet locations, specify the fleet to be updated and provide a list of one - or more locations. - - - - If successful, this operation returns the list of added locations with their status - set to NEW. GameLift initiates the process of starting an instance in - each added location. You can track the status of each new location by monitoring location - creation events using DescribeFleetEvents. Alternatively, you can poll location - status by calling DescribeFleetLocationAttributes. After a location status - becomes ACTIVE, you can adjust the location's capacity as needed with - UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleetLocations service method. - - The response from the CreateFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleetLocations Operation - - - - Adds remote locations to a fleet and begins populating the new locations with EC2 - instances. The new instances conform to the fleet's instance type, auto-scaling, and - other configuration settings. - - - - This operation cannot be used with fleets that don't support remote locations. Fleets - can have multiple locations only if they reside in AWS Regions that support this feature - (see CreateFleet for the complete list) and were created after the feature - was released in March 2021. - - - - To add fleet locations, specify the fleet to be updated and provide a list of one - or more locations. - - - - If successful, this operation returns the list of added locations with their status - set to NEW. GameLift initiates the process of starting an instance in - each added location. You can track the status of each new location by monitoring location - creation events using DescribeFleetEvents. Alternatively, you can poll location - status by calling DescribeFleetLocationAttributes. After a location status - becomes ACTIVE, you can adjust the location's capacity as needed with - UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleetLocations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleetLocations Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a GameLift FleetIQ game server group for managing game hosting on a collection - of Amazon EC2 instances for game hosting. This operation creates the game server group, - creates an Auto Scaling group in your AWS account, and establishes a link between - the two groups. You can view the status of your game server groups in the GameLift - console. Game server group metrics and events are emitted to Amazon CloudWatch. - - - - Before creating a new game server group, you must have the following: - -
  • - - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with - your game server build. For more information, see - Launching an Instance from a Launch Template in the Amazon EC2 User Guide. - - -
  • - - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ - to create and interact with the Auto Scaling group. For more information, see Create - IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. - -
- - To create a new game server group, specify a unique group name, IAM role and Amazon - EC2 launch template, and provide a list of instance types that can be used in the - group. You must also set initial maximum and minimum limits on the group's instance - count. You can optionally set an Auto Scaling policy with target tracking based on - a GameLift FleetIQ metric. - - - - Once the game server group and corresponding Auto Scaling group are created, you have - full access to change the Auto Scaling group's configuration as needed. Several properties - that are set when creating a game server group, including maximum/minimum size and - auto-scaling policy settings, must be updated directly in the Auto Scaling group. - Keep in mind that some Auto Scaling group properties are periodically updated by GameLift - FleetIQ as part of its balancing activities to optimize for availability and cost. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameServerGroup service method. - - The response from the CreateGameServerGroup service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a GameLift FleetIQ game server group for managing game hosting on a collection - of Amazon EC2 instances for game hosting. This operation creates the game server group, - creates an Auto Scaling group in your AWS account, and establishes a link between - the two groups. You can view the status of your game server groups in the GameLift - console. Game server group metrics and events are emitted to Amazon CloudWatch. - - - - Before creating a new game server group, you must have the following: - -
  • - - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with - your game server build. For more information, see - Launching an Instance from a Launch Template in the Amazon EC2 User Guide. - - -
  • - - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ - to create and interact with the Auto Scaling group. For more information, see Create - IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. - -
- - To create a new game server group, specify a unique group name, IAM role and Amazon - EC2 launch template, and provide a list of instance types that can be used in the - group. You must also set initial maximum and minimum limits on the group's instance - count. You can optionally set an Auto Scaling policy with target tracking based on - a GameLift FleetIQ metric. - - - - Once the game server group and corresponding Auto Scaling group are created, you have - full access to change the Auto Scaling group's configuration as needed. Several properties - that are set when creating a game server group, including maximum/minimum size and - auto-scaling policy settings, must be updated directly in the Auto Scaling group. - Keep in mind that some Auto Scaling group properties are periodically updated by GameLift - FleetIQ as part of its balancing activities to optimize for availability and cost. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameServerGroup service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameServerGroup Operation - - - - Creates a multiplayer game session for players in a specific fleet location. This - operation prompts an available server process to start a game session and retrieves - connection information for the new game session. As an alternative, consider using - the GameLift game session placement feature with - - - - with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to - optimize the placement process. - - - - When creating a game session, you specify exactly where you want to place it and provide - a set of game session configuration settings. The fleet must be in ACTIVE - status before a game session can be created in it. - - - - This operation can be used in the following ways: - -
  • - - To create a game session on an instance in a fleet's home Region, provide a fleet - or alias ID along with your game session configuration. - -
  • - - To create a game session on an instance in a fleet's remote location, provide a fleet - or alias ID and a location name, along with your game session configuration. - -
- - If successful, a workflow is initiated to start a new game session. A GameSession - object is returned containing the game session configuration and status. When the - status is ACTIVE, game session connection information is provided and - player sessions can be created for the game session. By default, newly created game - sessions are open to new players. You can restrict new player access by using UpdateGameSession - to change the game session's player session creation policy. - - - - Game session logs are retained for all active game sessions for 14 days. To access - the logs, call GetGameSessionLogUrl to download the log files. - - - - Available in GameLift Local. - - - - Learn more - - - - Start - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSession service method. - - The response from the CreateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The specified fleet has no available instances to fulfill a CreateGameSession - request. Clients can retry such requests immediately or after a waiting period. - - - A game session with this custom ID string already exists in this fleet. Resolve this - conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSession Operation - - - - Creates a multiplayer game session for players in a specific fleet location. This - operation prompts an available server process to start a game session and retrieves - connection information for the new game session. As an alternative, consider using - the GameLift game session placement feature with - - - - with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to - optimize the placement process. - - - - When creating a game session, you specify exactly where you want to place it and provide - a set of game session configuration settings. The fleet must be in ACTIVE - status before a game session can be created in it. - - - - This operation can be used in the following ways: - -
  • - - To create a game session on an instance in a fleet's home Region, provide a fleet - or alias ID along with your game session configuration. - -
  • - - To create a game session on an instance in a fleet's remote location, provide a fleet - or alias ID and a location name, along with your game session configuration. - -
- - If successful, a workflow is initiated to start a new game session. A GameSession - object is returned containing the game session configuration and status. When the - status is ACTIVE, game session connection information is provided and - player sessions can be created for the game session. By default, newly created game - sessions are open to new players. You can restrict new player access by using UpdateGameSession - to change the game session's player session creation policy. - - - - Game session logs are retained for all active game sessions for 14 days. To access - the logs, call GetGameSessionLogUrl to download the log files. - - - - Available in GameLift Local. - - - - Learn more - - - - Start - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The specified fleet has no available instances to fulfill a CreateGameSession - request. Clients can retry such requests immediately or after a waiting period. - - - A game session with this custom ID string already exists in this fleet. Resolve this - conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSession Operation - - - - Creates a placement queue that processes requests for new game sessions. A queue uses - FleetIQ algorithms to determine the best placement locations and find an available - game server there, then prompts the game server process to start a new game session. - - - - - A game session queue is configured with a set of destinations (GameLift fleets or - aliases), which determine the locations where the queue can place new game sessions. - These destinations can span multiple fleet types (Spot and On-Demand), instance types, - and AWS Regions. If the queue includes multi-location fleets, the queue is able to - place game sessions in all of a fleet's remote locations. You can opt to filter out - individual locations if needed. - - - - The queue configuration also determines how FleetIQ selects the best available placement - for a new game session. Before searching for an available game server, FleetIQ first - prioritizes the queue's destinations and locations, with the best placement locations - on top. You can set up the queue to use the FleetIQ default prioritization or provide - an alternate set of priorities. - - - - To create a new queue, provide a name, timeout value, and a list of destinations. - Optionally, specify a sort configuration and/or a filter, and define a set of latency - cap policies. You can also include the ARN for an Amazon Simple Notification Service - (SNS) topic to receive notifications of game session placement activity. Notifications - using SNS or CloudWatch events is the preferred way to track placement activity. - - - - If successful, a new GameSessionQueue object is returned with an assigned - queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement - or StartMatchmaking, reference a queue's name or ARN. - - - - Learn more - - - - - Design a game session queue - - - - - Create a game session queue - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSessionQueue service method. - - The response from the CreateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSessionQueue Operation - - - - Creates a placement queue that processes requests for new game sessions. A queue uses - FleetIQ algorithms to determine the best placement locations and find an available - game server there, then prompts the game server process to start a new game session. - - - - - A game session queue is configured with a set of destinations (GameLift fleets or - aliases), which determine the locations where the queue can place new game sessions. - These destinations can span multiple fleet types (Spot and On-Demand), instance types, - and AWS Regions. If the queue includes multi-location fleets, the queue is able to - place game sessions in all of a fleet's remote locations. You can opt to filter out - individual locations if needed. - - - - The queue configuration also determines how FleetIQ selects the best available placement - for a new game session. Before searching for an available game server, FleetIQ first - prioritizes the queue's destinations and locations, with the best placement locations - on top. You can set up the queue to use the FleetIQ default prioritization or provide - an alternate set of priorities. - - - - To create a new queue, provide a name, timeout value, and a list of destinations. - Optionally, specify a sort configuration and/or a filter, and define a set of latency - cap policies. You can also include the ARN for an Amazon Simple Notification Service - (SNS) topic to receive notifications of game session placement activity. Notifications - using SNS or CloudWatch events is the preferred way to track placement activity. - - - - If successful, a new GameSessionQueue object is returned with an assigned - queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement - or StartMatchmaking, reference a queue's name or ARN. - - - - Learn more - - - - - Design a game session queue - - - - - Create a game session queue - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSessionQueue Operation - - - - Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - configuration sets out rules for matching players and forming teams. If you're also - using GameLift hosting, it defines how to start game sessions for each match. Your - matchmaking system can use multiple configurations to handle different game scenarios. - All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify - the matchmaking configuration to use and provide player attributes consistent with - that configuration. - - - - To create a matchmaking configuration, you must provide the following: configuration - name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies - how to evaluate players and find acceptable matches; whether player acceptance is - required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch - with GameLift hosting, you also need to identify the game session queue to use when - starting a game session for the match. - - - - In addition, you must set up an Amazon Simple Notification Service (SNS) topic to - receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. - An alternative method, continuously polling ticket status with DescribeMatchmaking, - is only suitable for games in development with low matchmaking usage. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - - Set up FlexMatch event notification - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingConfiguration service method. - - The response from the CreateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingConfiguration Operation - - - - Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - configuration sets out rules for matching players and forming teams. If you're also - using GameLift hosting, it defines how to start game sessions for each match. Your - matchmaking system can use multiple configurations to handle different game scenarios. - All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify - the matchmaking configuration to use and provide player attributes consistent with - that configuration. - - - - To create a matchmaking configuration, you must provide the following: configuration - name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies - how to evaluate players and find acceptable matches; whether player acceptance is - required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch - with GameLift hosting, you also need to identify the game session queue to use when - starting a game session for the match. - - - - In addition, you must set up an Amazon Simple Notification Service (SNS) topic to - receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. - An alternative method, continuously polling ticket status with DescribeMatchmaking, - is only suitable for games in development with low matchmaking usage. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - - Set up FlexMatch event notification - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingConfiguration Operation - - - - Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of - match to create, such as the number and size of teams. It also sets the parameters - for acceptable player matches, such as minimum skill level or character type. A rule - set is used by a MatchmakingConfiguration. - - - - To create a matchmaking rule set, provide unique rule set name and the rule set body - in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration - they are used with. - - - - Since matchmaking rule sets cannot be edited, it is a good idea to check the rule - set syntax using ValidateMatchmakingRuleSet before creating a new rule set. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingRuleSet service method. - - The response from the CreateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingRuleSet Operation - - - - Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of - match to create, such as the number and size of teams. It also sets the parameters - for acceptable player matches, such as minimum skill level or character type. A rule - set is used by a MatchmakingConfiguration. - - - - To create a matchmaking rule set, provide unique rule set name and the rule set body - in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration - they are used with. - - - - Since matchmaking rule sets cannot be edited, it is a good idea to check the rule - set syntax using ValidateMatchmakingRuleSet before creating a new rule set. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingRuleSet Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add a player to. - A unique identifier for a player. Player IDs are developer-defined. - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSession service method. - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add a player to. - A unique identifier for a player. Player IDs are developer-defined. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add players to. - List of unique identifiers for the players to be added. - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSessions service method. - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add players to. - List of unique identifiers for the players to be added. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Creates a new script record for your Realtime Servers script. Realtime scripts are - JavaScript that provide configuration settings and optional custom game logic for - your game. The script is deployed when you create a Realtime Servers fleet to host - your game sessions. Script logic is executed during an active game session. - - - - To create a new script record, specify a script name and provide the script file(s). - The script files and all dependencies must be zipped into a single file. You can pull - the zip file from either of these locations: - -
  • - - A locally available directory. Use the ZipFile parameter for this option. - -
  • - - An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the - StorageLocation parameter for this option. You'll need to have an Identity - Access Management (IAM) role that allows the Amazon GameLift service to access your - S3 bucket. - -
- - If the call is successful, a new script record is created with a unique script ID. - If the script file is provided as a local file, the file is uploaded to an Amazon - GameLift-owned S3 bucket and the script record's storage location reflects this location. - If the script file is provided as an S3 bucket, Amazon GameLift accesses the file - at this storage location as needed for deployment. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Set - Up a Role for Amazon GameLift Access - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the CreateScript service method. - - The response from the CreateScript service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateScript Operation - - - - Creates a new script record for your Realtime Servers script. Realtime scripts are - JavaScript that provide configuration settings and optional custom game logic for - your game. The script is deployed when you create a Realtime Servers fleet to host - your game sessions. Script logic is executed during an active game session. - - - - To create a new script record, specify a script name and provide the script file(s). - The script files and all dependencies must be zipped into a single file. You can pull - the zip file from either of these locations: - -
  • - - A locally available directory. Use the ZipFile parameter for this option. - -
  • - - An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the - StorageLocation parameter for this option. You'll need to have an Identity - Access Management (IAM) role that allows the Amazon GameLift service to access your - S3 bucket. - -
- - If the call is successful, a new script record is created with a unique script ID. - If the script file is provided as a local file, the file is uploaded to an Amazon - GameLift-owned S3 bucket and the script record's storage location reflects this location. - If the script file is provided as an S3 bucket, Amazon GameLift accesses the file - at this storage location as needed for deployment. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Set - Up a Role for Amazon GameLift Access - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the CreateScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateScript service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateScript Operation - - - - Requests authorization to create or delete a peer connection between the VPC for your - Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering - enables the game servers on your fleet to communicate directly with other AWS resources. - Once you've received authorization, call CreateVpcPeeringConnection to establish - the peering connection. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - You can peer with VPCs that are owned by any AWS account you have access to, including - the account that you use to manage your Amazon GameLift fleets. You cannot peer with - VPCs that are in different Regions. - - - - To request authorization to create a connection, call this operation from the AWS - account with the VPC that you want to peer to your Amazon GameLift fleet. For example, - to enable your game servers to retrieve data from a DynamoDB table, use the account - that manages that DynamoDB resource. Identify the following values: (1) The ID of - the VPC that you want to peer with, and (2) the ID of the AWS account that you use - to manage Amazon GameLift. If successful, VPC peering is authorized for the specified - VPC. - - - - To request authorization to delete a connection, call this operation from the AWS - account with the VPC that is peered with your Amazon GameLift fleet. Identify the - following values: (1) VPC ID that you want to delete the peering connection for, and - (2) ID of the AWS account that you use to manage Amazon GameLift. - - - - The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. - You must create or delete the peering connection while the authorization is valid. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringAuthorization service method. - - The response from the CreateVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringAuthorization Operation - - - - Requests authorization to create or delete a peer connection between the VPC for your - Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering - enables the game servers on your fleet to communicate directly with other AWS resources. - Once you've received authorization, call CreateVpcPeeringConnection to establish - the peering connection. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - You can peer with VPCs that are owned by any AWS account you have access to, including - the account that you use to manage your Amazon GameLift fleets. You cannot peer with - VPCs that are in different Regions. - - - - To request authorization to create a connection, call this operation from the AWS - account with the VPC that you want to peer to your Amazon GameLift fleet. For example, - to enable your game servers to retrieve data from a DynamoDB table, use the account - that manages that DynamoDB resource. Identify the following values: (1) The ID of - the VPC that you want to peer with, and (2) the ID of the AWS account that you use - to manage Amazon GameLift. If successful, VPC peering is authorized for the specified - VPC. - - - - To request authorization to delete a connection, call this operation from the AWS - account with the VPC that is peered with your Amazon GameLift fleet. Identify the - following values: (1) VPC ID that you want to delete the peering connection for, and - (2) ID of the AWS account that you use to manage Amazon GameLift. - - - - The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. - You must create or delete the peering connection while the authorization is valid. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringAuthorization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringAuthorization Operation - - - - Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS - account with the VPC for your Amazon GameLift fleet. VPC peering enables the game - servers on your fleet to communicate directly with other AWS resources. You can peer - with VPCs in any AWS account that you have access to, including the account that you - use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different - Regions. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - Before calling this operation to establish the peering connection, you first need - to call CreateVpcPeeringAuthorization and identify the VPC you want to peer - with. Once the authorization for the specified VPC is issued, you have 24 hours to - establish the connection. These two operations handle all tasks necessary to peer - the two VPCs, including acceptance, updating routing tables, etc. - - - - To establish the connection, call this operation from the AWS account that is used - to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of - the fleet you want to be enable a VPC peering connection for; (2) The AWS account - with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer - with. This operation is asynchronous. If successful, a VpcPeeringConnection - request is created. You can use continuous polling to track the request's status using - DescribeVpcPeeringConnections, or by monitoring fleet events for success or - failure using DescribeFleetEvents. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringConnection service method. - - The response from the CreateVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringConnection Operation - - - - Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS - account with the VPC for your Amazon GameLift fleet. VPC peering enables the game - servers on your fleet to communicate directly with other AWS resources. You can peer - with VPCs in any AWS account that you have access to, including the account that you - use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different - Regions. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - Before calling this operation to establish the peering connection, you first need - to call CreateVpcPeeringAuthorization and identify the VPC you want to peer - with. Once the authorization for the specified VPC is issued, you have 24 hours to - establish the connection. These two operations handle all tasks necessary to peer - the two VPCs, including acceptance, updating routing tables, etc. - - - - To establish the connection, call this operation from the AWS account that is used - to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of - the fleet you want to be enable a VPC peering connection for; (2) The AWS account - with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer - with. This operation is asynchronous. If successful, a VpcPeeringConnection - request is created. You can use continuous polling to track the request's status using - DescribeVpcPeeringConnections, or by monitoring fleet events for success or - failure using DescribeFleetEvents. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringConnection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringConnection Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value. - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DeleteAlias service method. - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DeleteAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to delete. You can use either the build ID or ARN value. - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DeleteBuild service method. - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to delete. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DeleteBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value. - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleet service method. - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Removes locations from a multi-location fleet. When deleting a location, all game - server process and all instances that are still active in the location are shut down. - - - - - To delete fleet locations, identify the fleet ID and provide a list of the locations - to be deleted. - - - - If successful, GameLift sets the location status to DELETING, and begins - to shut down existing server processes and terminate instances in each location being - deleted. When completed, the location status changes to TERMINATED. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleetLocations service method. - - The response from the DeleteFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleetLocations Operation - - - - Removes locations from a multi-location fleet. When deleting a location, all game - server process and all instances that are still active in the location are shut down. - - - - - To delete fleet locations, identify the fleet ID and provide a list of the locations - to be deleted. - - - - If successful, GameLift sets the location status to DELETING, and begins - to shut down existing server processes and terminate instances in each location being - deleted. When completed, the location status changes to TERMINATED. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleetLocations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleetLocations Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Terminates a game server group and permanently deletes the game server group record. - You have several options for how these resources are impacted when deleting the game - server group. Depending on the type of delete operation selected, this operation might - affect these resources: - -
  • - - The game server group - -
  • - - The corresponding Auto Scaling group - -
  • - - All game servers that are currently running in the group - -
- - To delete a game server group, identify the game server group to delete and specify - the type of delete operation to initiate. Game server groups can only be deleted if - they are in ACTIVE or ERROR status. - - - - If the delete request is successful, a series of operations are kicked off. The game - server group status is changed to DELETE_SCHEDULED, which prevents new - game servers from being registered and stops automatic scaling activity. Once all - game servers in the game server group are deregistered, GameLift FleetIQ can begin - deleting resources. If any of the delete operations fail, the game server group is - placed in ERROR status. - - - - GameLift FleetIQ emits delete events to Amazon CloudWatch. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameServerGroup service method. - - The response from the DeleteGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Terminates a game server group and permanently deletes the game server group record. - You have several options for how these resources are impacted when deleting the game - server group. Depending on the type of delete operation selected, this operation might - affect these resources: - -
  • - - The game server group - -
  • - - The corresponding Auto Scaling group - -
  • - - All game servers that are currently running in the group - -
- - To delete a game server group, identify the game server group to delete and specify - the type of delete operation to initiate. Game server groups can only be deleted if - they are in ACTIVE or ERROR status. - - - - If the delete request is successful, a series of operations are kicked off. The game - server group status is changed to DELETE_SCHEDULED, which prevents new - game servers from being registered and stops automatic scaling activity. Once all - game servers in the game server group are deregistered, GameLift FleetIQ can begin - deleting resources. If any of the delete operations fail, the game server group is - placed in ERROR status. - - - - GameLift FleetIQ emits delete events to Amazon CloudWatch. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameServerGroup Operation - - - - Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement - requests that reference the queue will fail. To delete a queue, specify the queue - name. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameSessionQueue service method. - - The response from the DeleteGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameSessionQueue Operation - - - - Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement - requests that reference the queue will fail. To delete a queue, specify the queue - name. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameSessionQueue Operation - - - - Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - configuration name. A matchmaking configuration cannot be deleted if it is being used - in any active matchmaking tickets. - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingConfiguration service method. - - The response from the DeleteMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingConfiguration Operation - - - - Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - configuration name. A matchmaking configuration cannot be deleted if it is being used - in any active matchmaking tickets. - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingConfiguration Operation - - - - Deletes an existing matchmaking rule set. To delete the rule set, provide the rule - set name. Rule sets cannot be deleted if they are currently being used by a matchmaking - configuration. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingRuleSet service method. - - The response from the DeleteMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingRuleSet Operation - - - - Deletes an existing matchmaking rule set. To delete the rule set, provide the rule - set name. Rule sets cannot be deleted if they are currently being used by a matchmaking - configuration. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingRuleSet Operation - - - - Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - GameLift removes all record of it. To delete a scaling policy, specify both the scaling - policy name and the fleet ID it is associated with. - - - - To temporarily suspend scaling policies, call StopFleetActions. This operation - suspends all policies for the fleet. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScalingPolicy service method. - - The response from the DeleteScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScalingPolicy Operation - - - - Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - GameLift removes all record of it. To delete a scaling policy, specify both the scaling - policy name and the fleet ID it is associated with. - - - - To temporarily suspend scaling policies, call StopFleetActions. This operation - suspends all policies for the fleet. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScalingPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScalingPolicy Operation - - - - Deletes a Realtime script. This operation permanently deletes the script record. If - script files were uploaded, they are also deleted (files stored in an S3 bucket are - not deleted). - - - - To delete a script, specify the script ID. Before deleting a script, be sure to terminate - all fleets that are deployed with the script being deleted. Fleet instances periodically - check for script updates, and if the script record no longer exists, the instance - will go into an error state and be unable to host game sessions. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScript service method. - - The response from the DeleteScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScript Operation - - - - Deletes a Realtime script. This operation permanently deletes the script record. If - script files were uploaded, they are also deleted (files stored in an S3 bucket are - not deleted). - - - - To delete a script, specify the script ID. Before deleting a script, be sure to terminate - all fleets that are deployed with the script being deleted. Fleet instances periodically - check for script updates, and if the script record no longer exists, the instance - will go into an error state and be unable to host game sessions. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScript Operation - - - - Cancels a pending VPC peering authorization for the specified VPC. If you need to - delete an existing VPC peering connection, call DeleteVpcPeeringConnection. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringAuthorization service method. - - The response from the DeleteVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringAuthorization Operation - - - - Cancels a pending VPC peering authorization for the specified VPC. If you need to - delete an existing VPC peering connection, call DeleteVpcPeeringConnection. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringAuthorization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringAuthorization Operation - - - - Removes a VPC peering connection. To delete the connection, you must have a valid - authorization for the VPC peering connection that you want to delete. You can check - for an authorization by calling DescribeVpcPeeringAuthorizations or request - a new one using CreateVpcPeeringAuthorization. - - - - Once a valid authorization exists, call this operation from the AWS account that is - used to manage the Amazon GameLift fleets. Identify the connection to delete by the - connection ID and fleet ID. If successful, the connection is removed. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method. - - The response from the DeleteVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringConnection Operation - - - - Removes a VPC peering connection. To delete the connection, you must have a valid - authorization for the VPC peering connection that you want to delete. You can check - for an authorization by calling DescribeVpcPeeringAuthorizations or request - a new one using CreateVpcPeeringAuthorization. - - - - Once a valid authorization exists, call this operation from the AWS account that is - used to manage the Amazon GameLift fleets. Identify the connection to delete by the - connection ID and fleet ID. If successful, the connection is removed. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringConnection Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Removes the game server from a game server group. As a result of this operation, the - deregistered game server can no longer be claimed and will not be returned in a list - of active game servers. - - - - To deregister a game server, specify the game server group and game server ID. If - successful, this operation emits a CloudWatch event with termination timestamp and - reason. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DeregisterGameServer service method. - - The response from the DeregisterGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeregisterGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Removes the game server from a game server group. As a result of this operation, the - deregistered game server can no longer be claimed and will not be returned in a list - of active game servers. - - - - To deregister a game server, specify the game server group and game server ID. If - successful, this operation emits a CloudWatch event with termination timestamp and - reason. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DeregisterGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeregisterGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeregisterGameServer Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DescribeAlias service method. - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DescribeAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DescribeBuild service method. - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DescribeBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types. - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeEC2InstanceLimits service method. - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeEC2InstanceLimits service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - Retrieves core fleet-wide properties, including the computing hardware and deployment - configuration for all instances in the fleet. - - - - This operation can be used in the following ways: - -
  • - - To get attributes for one or more specific fleets, provide a list of fleet IDs or - fleet ARNs. - -
  • - - To get attributes for all fleets, do not provide a fleet identifier. - -
- - When requesting attributes for multiple fleets, use the pagination parameters to retrieve - results as a set of sequential pages. - - - - If successful, a FleetAttributes object is returned for each fleet requested, - unless the fleet identifier is not found. - - - - Some API operations limit the number of fleet IDs that allowed in one request. If - a request exceeds this limit, the request fails and the error message contains the - maximum allowed number. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetAttributes service method. - - The response from the DescribeFleetAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetAttributes Operation - - - - Retrieves core fleet-wide properties, including the computing hardware and deployment - configuration for all instances in the fleet. - - - - This operation can be used in the following ways: - -
  • - - To get attributes for one or more specific fleets, provide a list of fleet IDs or - fleet ARNs. - -
  • - - To get attributes for all fleets, do not provide a fleet identifier. - -
- - When requesting attributes for multiple fleets, use the pagination parameters to retrieve - results as a set of sequential pages. - - - - If successful, a FleetAttributes object is returned for each fleet requested, - unless the fleet identifier is not found. - - - - Some API operations limit the number of fleet IDs that allowed in one request. If - a request exceeds this limit, the request fails and the error message contains the - maximum allowed number. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetAttributes Operation - - - - Retrieves the resource capacity settings for one or more fleets. The data returned - includes the current fleet capacity (number of EC2 instances), and settings that can - control how capacity scaling. For fleets with remote locations, this operation retrieves - data for the fleet's home Region only. See DescribeFleetLocationCapacity to - get capacity settings for a fleet's remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get capacity data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get capacity data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetCapacity object is returned for each requested fleet - ID. Each FleetCapacity object includes a Location property, which is - set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - are returned only for fleets that currently exist. - - - - Some API operations may limit the number of fleet IDs that are allowed in one request. - If a request exceeds this limit, the request fails and the error message includes - the maximum allowed. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetCapacity service method. - - The response from the DescribeFleetCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetCapacity Operation - - - - Retrieves the resource capacity settings for one or more fleets. The data returned - includes the current fleet capacity (number of EC2 instances), and settings that can - control how capacity scaling. For fleets with remote locations, this operation retrieves - data for the fleet's home Region only. See DescribeFleetLocationCapacity to - get capacity settings for a fleet's remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get capacity data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get capacity data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetCapacity object is returned for each requested fleet - ID. Each FleetCapacity object includes a Location property, which is - set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - are returned only for fleets that currently exist. - - - - Some API operations may limit the number of fleet IDs that are allowed in one request. - If a request exceeds this limit, the request fails and the error message includes - the maximum allowed. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetCapacity Operation - - - - Retrieves entries from a fleet's event log. Fleet events are initiated by changes - in status, such as during fleet creation and termination, changes in capacity, etc. - If a fleet has multiple locations, events are also initiated by changes to status - and capacity in remote locations. - - - - You can specify a time range to limit the result set. Use the pagination parameters - to retrieve results as a set of sequential pages. - - - - If successful, a collection of event log entries matching the request are returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetEvents service method. - - The response from the DescribeFleetEvents service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetEvents Operation - - - - Retrieves entries from a fleet's event log. Fleet events are initiated by changes - in status, such as during fleet creation and termination, changes in capacity, etc. - If a fleet has multiple locations, events are also initiated by changes to status - and capacity in remote locations. - - - - You can specify a time range to limit the result set. Use the pagination parameters - to retrieve results as a set of sequential pages. - - - - If successful, a collection of event log entries matching the request are returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetEvents service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetEvents Operation - - - - Retrieves information on a fleet's remote locations, including life-cycle status and - any suspended fleet activity. - - - - This operation can be used in the following ways: - -
  • - - To get data for specific locations, provide a fleet identifier and a list of locations. - Location data is returned in the order that it is requested. - -
  • - - To get data for all locations, provide a fleet identifier only. Location data is returned - in no particular order. - -
- - When requesting attributes for multiple locations, use the pagination parameters to - retrieve results as a set of sequential pages. - - - - If successful, a LocationAttributes object is returned for each requested - location. If the fleet does not have a requested location, no information is returned. - This operation does not return the home Region. To get information on a fleet's home - Region, call DescribeFleetAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationAttributes service method. - - The response from the DescribeFleetLocationAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationAttributes Operation - - - - Retrieves information on a fleet's remote locations, including life-cycle status and - any suspended fleet activity. - - - - This operation can be used in the following ways: - -
  • - - To get data for specific locations, provide a fleet identifier and a list of locations. - Location data is returned in the order that it is requested. - -
  • - - To get data for all locations, provide a fleet identifier only. Location data is returned - in no particular order. - -
- - When requesting attributes for multiple locations, use the pagination parameters to - retrieve results as a set of sequential pages. - - - - If successful, a LocationAttributes object is returned for each requested - location. If the fleet does not have a requested location, no information is returned. - This operation does not return the home Region. To get information on a fleet's home - Region, call DescribeFleetAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationAttributes Operation - - - - Retrieves the resource capacity settings for a fleet location. The data returned includes - the current capacity (number of EC2 instances) and some scaling settings for the requested - fleet location. Use this operation to retrieve capacity information for a fleet's - remote location or home Region (you can also retrieve home Region capacity by calling - DescribeFleetCapacity). - - - - To retrieve capacity data, identify a fleet and location. - - - - If successful, a FleetCapacity object is returned for the requested fleet - location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationCapacity service method. - - The response from the DescribeFleetLocationCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationCapacity Operation - - - - Retrieves the resource capacity settings for a fleet location. The data returned includes - the current capacity (number of EC2 instances) and some scaling settings for the requested - fleet location. Use this operation to retrieve capacity information for a fleet's - remote location or home Region (you can also retrieve home Region capacity by calling - DescribeFleetCapacity). - - - - To retrieve capacity data, identify a fleet and location. - - - - If successful, a FleetCapacity object is returned for the requested fleet - location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationCapacity Operation - - - - Retrieves current usage data for a fleet location. Utilization data provides a snapshot - of current game hosting activity at the requested location. Use this operation to - retrieve utilization information for a fleet's remote location or home Region (you - can also retrieve home Region utilization by calling DescribeFleetUtilization). - - - - To retrieve utilization data, identify a fleet and location. - - - - If successful, a FleetUtilization object is returned for the requested - fleet location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationUtilization service method. - - The response from the DescribeFleetLocationUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationUtilization Operation - - - - Retrieves current usage data for a fleet location. Utilization data provides a snapshot - of current game hosting activity at the requested location. Use this operation to - retrieve utilization information for a fleet's remote location or home Region (you - can also retrieve home Region utilization by calling DescribeFleetUtilization). - - - - To retrieve utilization data, identify a fleet and location. - - - - If successful, a FleetUtilization object is returned for the requested - fleet location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationUtilization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationUtilization Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value. - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetPortSettings service method. - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetPortSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves utilization statistics for one or more fleets. Utilization data provides - a snapshot of how the fleet's hosting resources are currently being used. For fleets - with remote locations, this operation retrieves data for the fleet's home Region only. - See DescribeFleetLocationUtilization to get utilization statistics for a fleet's - remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get utilization data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get utilization data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetUtilization object is returned for each requested fleet - ID, unless the fleet identifier is not found. Each fleet utilization object includes - a Location property, which is set to the fleet's home Region. - - - - Some API operations may limit the number of fleet IDs allowed in one request. If a - request exceeds this limit, the request fails and the error message includes the maximum - allowed. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - GameLift - Metrics for Fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetUtilization service method. - - The response from the DescribeFleetUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetUtilization Operation - - - - Retrieves utilization statistics for one or more fleets. Utilization data provides - a snapshot of how the fleet's hosting resources are currently being used. For fleets - with remote locations, this operation retrieves data for the fleet's home Region only. - See DescribeFleetLocationUtilization to get utilization statistics for a fleet's - remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get utilization data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get utilization data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetUtilization object is returned for each requested fleet - ID, unless the fleet identifier is not found. Each fleet utilization object includes - a Location property, which is set to the fleet's home Region. - - - - Some API operations may limit the number of fleet IDs allowed in one request. If a - request exceeds this limit, the request fails and the error message includes the maximum - allowed. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - GameLift - Metrics for Fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetUtilization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetUtilization Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information for a registered game server. Information includes game server - status, health check info, and the instance that the game server is running on. - - - - To retrieve game server information, specify the game server ID. If successful, the - requested game server object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServer service method. - - The response from the DescribeGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information for a registered game server. Information includes game server - status, health check info, and the instance that the game server is running on. - - - - To retrieve game server information, specify the game server ID. If successful, the - requested game server object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on a game server group. This operation returns only properties - related to GameLift FleetIQ. To view or update properties for the corresponding Auto - Scaling group, such as launch template, auto scaling policies, and maximum/minimum - group size, access the Auto Scaling group directly. - - - - To get attributes for a game server group, provide a group name or ARN value. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerGroup service method. - - The response from the DescribeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on a game server group. This operation returns only properties - related to GameLift FleetIQ. To view or update properties for the corresponding Auto - Scaling group, such as launch template, auto scaling policies, and maximum/minimum - group size, access the Auto Scaling group directly. - - - - To get attributes for a game server group, provide a group name or ARN value. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves status information about the Amazon EC2 instances associated with a GameLift - FleetIQ game server group. Use this operation to detect when instances are active - or not available to host new game servers. If you are looking for instance configuration - information, call DescribeGameServerGroup or access the corresponding Auto - Scaling group properties. - - - - To request status for all instances in the game server group, provide a game server - group ID only. To request status for specific instances, provide the game server group - ID and one or more instance IDs. Use the pagination parameters to retrieve results - in sequential segments. If successful, a collection of GameServerInstance - objects is returned. - - - - This operation is not designed to be called with every game server claim request; - this practice can cause you to exceed your API limit, which results in errors. Instead, - as a best practice, cache the results and refresh your cache no more than once every - 10 seconds. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerInstances service method. - - The response from the DescribeGameServerInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerInstances Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves status information about the Amazon EC2 instances associated with a GameLift - FleetIQ game server group. Use this operation to detect when instances are active - or not available to host new game servers. If you are looking for instance configuration - information, call DescribeGameServerGroup or access the corresponding Auto - Scaling group properties. - - - - To request status for all instances in the game server group, provide a game server - group ID only. To request status for specific instances, provide the game server group - ID and one or more instance IDs. Use the pagination parameters to retrieve results - in sequential segments. If successful, a collection of GameServerInstance - objects is returned. - - - - This operation is not designed to be called with every game server claim request; - this practice can cause you to exceed your API limit, which results in errors. Instead, - as a best practice, cache the results and refresh your cache no more than once every - 10 seconds. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServerInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerInstances Operation - - - - Retrieves additional game session properties, including the game session protection - policy in force, a set of one or more game sessions in a specific fleet location. - You can optionally filter the results by current game session status. Alternatively, - use SearchGameSessions to request a set of active game sessions that are filtered - by certain criteria. To retrieve all game session properties, use DescribeGameSessions. - - - - - This operation can be used in the following ways: - -
  • - - To retrieve details for all game sessions that are currently running on all locations - in a fleet, provide a fleet or alias ID, with an optional status filter. This approach - returns details from the fleet's home Region and all remote locations. - -
  • - - To retrieve details for all game sessions that are currently running on a specific - fleet location, provide a fleet or alias ID and a location name, with optional status - filter. The location can be the fleet's home Region or any remote location. - -
  • - - To retrieve details for a specific game session, provide the game session ID. This - approach looks for the game session ID in all fleets that reside in the AWS Region - defined in the request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSessionDetail object is returned for each game session - that matches the request. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionDetails service method. - - The response from the DescribeGameSessionDetails service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionDetails Operation - - - - Retrieves additional game session properties, including the game session protection - policy in force, a set of one or more game sessions in a specific fleet location. - You can optionally filter the results by current game session status. Alternatively, - use SearchGameSessions to request a set of active game sessions that are filtered - by certain criteria. To retrieve all game session properties, use DescribeGameSessions. - - - - - This operation can be used in the following ways: - -
  • - - To retrieve details for all game sessions that are currently running on all locations - in a fleet, provide a fleet or alias ID, with an optional status filter. This approach - returns details from the fleet's home Region and all remote locations. - -
  • - - To retrieve details for all game sessions that are currently running on a specific - fleet location, provide a fleet or alias ID and a location name, with optional status - filter. The location can be the fleet's home Region or any remote location. - -
  • - - To retrieve details for a specific game session, provide the game session ID. This - approach looks for the game session ID in all fleets that reside in the AWS Region - defined in the request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSessionDetail object is returned for each game session - that matches the request. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionDetails service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionDetails service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionDetails Operation - - - - Retrieves information, including current status, about a game session placement request. - - - - - To get game session placement details, specify the placement ID. - - - - If successful, a GameSessionPlacement object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionPlacement service method. - - The response from the DescribeGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionPlacement Operation - - - - Retrieves information, including current status, about a game session placement request. - - - - - To get game session placement details, specify the placement ID. - - - - If successful, a GameSessionPlacement object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionPlacement Operation - - - - Retrieves the properties for one or more game session queues. When requesting multiple - queues, use the pagination parameters to retrieve results as a set of sequential pages. - If successful, a GameSessionQueue object is returned for each requested queue. - When specifying a list of queues, objects are returned only for queues that currently - exist in the Region. - - - - Learn more - - - - - View Your Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionQueues service method. - - The response from the DescribeGameSessionQueues service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionQueues Operation - - - - Retrieves the properties for one or more game session queues. When requesting multiple - queues, use the pagination parameters to retrieve results as a set of sequential pages. - If successful, a GameSessionQueue object is returned for each requested queue. - When specifying a list of queues, objects are returned only for queues that currently - exist in the Region. - - - - Learn more - - - - - View Your Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionQueues service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionQueues service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionQueues Operation - - - - Retrieves a set of one or more game sessions in a specific fleet location. You can - optionally filter the results by current game session status. Alternatively, use SearchGameSessions - to request a set of active game sessions that are filtered by certain criteria. To - retrieve the protection policy for game sessions, use DescribeGameSessionDetails. - - - - This operation can be used in the following ways: - -
  • - - To retrieve all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID, with an optional status filter. This approach returns - all game sessions in the fleet's home Region and all remote locations. - -
  • - - To retrieve all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name, with optional status filter. The - location can be the fleet's home Region or any remote location. - -
  • - - To retrieve a specific game session, provide the game session ID. This approach looks - for the game session ID in all fleets that reside in the AWS Region defined in the - request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. - - - - Available in GameLift Local. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessions service method. - - The response from the DescribeGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessions Operation - - - - Retrieves a set of one or more game sessions in a specific fleet location. You can - optionally filter the results by current game session status. Alternatively, use SearchGameSessions - to request a set of active game sessions that are filtered by certain criteria. To - retrieve the protection policy for game sessions, use DescribeGameSessionDetails. - - - - This operation can be used in the following ways: - -
  • - - To retrieve all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID, with an optional status filter. This approach returns - all game sessions in the fleet's home Region and all remote locations. - -
  • - - To retrieve all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name, with optional status filter. The - location can be the fleet's home Region or any remote location. - -
  • - - To retrieve a specific game session, provide the game session ID. This approach looks - for the game session ID in all fleets that reside in the AWS Region defined in the - request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. - - - - Available in GameLift Local. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessions Operation - - - - Retrieves information about a fleet's instances, including instance IDs, connection - data, and status. - - - - This operation can be used in the following ways: - -
  • - - To get information on all instances that are deployed to a fleet's home Region, provide - the fleet ID. - -
  • - - To get information on all instances that are deployed to a fleet's remote location, - provide the fleet ID and location name. - -
  • - - To get information on a specific instance in a fleet, provide the fleet ID and instance - ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, an Instance object is returned for each requested instance. - Instances are not returned in any particular order. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeInstances service method. - - The response from the DescribeInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeInstances Operation - - - - Retrieves information about a fleet's instances, including instance IDs, connection - data, and status. - - - - This operation can be used in the following ways: - -
  • - - To get information on all instances that are deployed to a fleet's home Region, provide - the fleet ID. - -
  • - - To get information on all instances that are deployed to a fleet's remote location, - provide the fleet ID and location name. - -
  • - - To get information on a specific instance in a fleet, provide the fleet ID and instance - ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, an Instance object is returned for each requested instance. - Instances are not returned in any particular order. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeInstances Operation - - - - Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, - including--after a successful match is made--connection information for the resulting - new game session. - - - - To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - is successful, a ticket object is returned for each requested ID that currently exists. - - - - This operation is not designed to be continually called to track matchmaking ticket - status. This practice can cause you to exceed your API limit, which results in errors. - Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to - receive notifications, and provide the topic ARN in the matchmaking configuration. - Continuously poling ticket status with DescribeMatchmaking should only be used - for games in development with low matchmaking usage. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmaking service method. - - The response from the DescribeMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmaking Operation - - - - Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, - including--after a successful match is made--connection information for the resulting - new game session. - - - - To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - is successful, a ticket object is returned for each requested ID that currently exists. - - - - This operation is not designed to be continually called to track matchmaking ticket - status. This practice can cause you to exceed your API limit, which results in errors. - Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to - receive notifications, and provide the topic ARN in the matchmaking configuration. - Continuously poling ticket status with DescribeMatchmaking should only be used - for games in development with low matchmaking usage. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmaking Operation - - - - Retrieves the details of FlexMatch matchmaking configurations. - - - - This operation offers the following options: (1) retrieve all matchmaking configurations, - (2) retrieve configurations for a specified list, or (3) retrieve all configurations - that use a specified rule set name. When requesting multiple items, use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a configuration is returned for each requested name. When specifying - a list of names, only configurations that currently exist are returned. - - - - Learn more - - - - - Setting up FlexMatch matchmakers - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingConfigurations service method. - - The response from the DescribeMatchmakingConfigurations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingConfigurations Operation - - - - Retrieves the details of FlexMatch matchmaking configurations. - - - - This operation offers the following options: (1) retrieve all matchmaking configurations, - (2) retrieve configurations for a specified list, or (3) retrieve all configurations - that use a specified rule set name. When requesting multiple items, use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a configuration is returned for each requested name. When specifying - a list of names, only configurations that currently exist are returned. - - - - Learn more - - - - - Setting up FlexMatch matchmakers - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmakingConfigurations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingConfigurations Operation - - - - Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - rule sets for the Region, or provide a list of one or more rule set names. When requesting - multiple items, use the pagination parameters to retrieve results as a set of sequential - pages. If successful, a rule set is returned for each requested name. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingRuleSets service method. - - The response from the DescribeMatchmakingRuleSets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingRuleSets Operation - - - - Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - rule sets for the Region, or provide a list of one or more rule set names. When requesting - multiple items, use the pagination parameters to retrieve results as a set of sequential - pages. If successful, a rule set is returned for each requested name. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingRuleSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmakingRuleSets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingRuleSets Operation - - - - Retrieves properties for one or more player sessions. - - - - This action can be used in the following ways: - -
  • - - To retrieve a specific player session, provide the player session ID only. - -
  • - - To retrieve all player sessions in a game session, provide the game session ID only. - -
  • - - To retrieve all player sessions for a specific player, provide a player ID only. - -
- - To request player sessions, specify either a player session ID, game session ID, or - player ID. You can filter this request by player session status. Use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a PlayerSession object is returned for each session that - matches the request. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the DescribePlayerSessions service method. - - The response from the DescribePlayerSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribePlayerSessions Operation - - - - Retrieves properties for one or more player sessions. - - - - This action can be used in the following ways: - -
  • - - To retrieve a specific player session, provide the player session ID only. - -
  • - - To retrieve all player sessions in a game session, provide the game session ID only. - -
  • - - To retrieve all player sessions for a specific player, provide a player ID only. - -
- - To request player sessions, specify either a player session ID, game session ID, or - player ID. You can filter this request by player session status. Use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a PlayerSession object is returned for each session that - matches the request. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the DescribePlayerSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribePlayerSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribePlayerSessions Operation - - - - Retrieves a fleet's runtime configuration settings. The runtime configuration tells - GameLift which server processes to run (and how) on each instance in the fleet. - - - - To get the runtime configuration that is currently in forces for a fleet, provide - the fleet ID. - - - - If successful, a RuntimeConfiguration object is returned for the requested - fleet. If the requested fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Running - multiple processes on a fleet - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeRuntimeConfiguration service method. - - The response from the DescribeRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeRuntimeConfiguration Operation - - - - Retrieves a fleet's runtime configuration settings. The runtime configuration tells - GameLift which server processes to run (and how) on each instance in the fleet. - - - - To get the runtime configuration that is currently in forces for a fleet, provide - the fleet ID. - - - - If successful, a RuntimeConfiguration object is returned for the requested - fleet. If the requested fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Running - multiple processes on a fleet - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeRuntimeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeRuntimeConfiguration Operation - - - - Retrieves all scaling policies applied to a fleet. - - - - To get a fleet's scaling policies, specify the fleet ID. You can filter this request - by policy status, such as to retrieve only active scaling policies. Use the pagination - parameters to retrieve results as a set of sequential pages. If successful, set of - ScalingPolicy objects is returned for the fleet. - - - - A fleet may have all of its scaling policies suspended (StopFleetActions). - This operation does not affect the status of the scaling policies, which remains ACTIVE. - To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes - and check the stopped actions. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScalingPolicies service method. - - The response from the DescribeScalingPolicies service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScalingPolicies Operation - - - - Retrieves all scaling policies applied to a fleet. - - - - To get a fleet's scaling policies, specify the fleet ID. You can filter this request - by policy status, such as to retrieve only active scaling policies. Use the pagination - parameters to retrieve results as a set of sequential pages. If successful, set of - ScalingPolicy objects is returned for the fleet. - - - - A fleet may have all of its scaling policies suspended (StopFleetActions). - This operation does not affect the status of the scaling policies, which remains ACTIVE. - To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes - and check the stopped actions. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScalingPolicies service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeScalingPolicies service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScalingPolicies Operation - - - - Retrieves properties for a Realtime script. - - - - To request a script record, specify the script ID. If successful, an object containing - the script properties is returned. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScript service method. - - The response from the DescribeScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScript Operation - - - - Retrieves properties for a Realtime script. - - - - To request a script record, specify the script ID. If successful, an object containing - the script properties is returned. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScript Operation - - - - Retrieves valid VPC peering authorizations that are pending for the AWS account. This - operation returns all VPC peering authorizations and requests for peering. This includes - those initiated and received by this account. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringAuthorizations service method. - - The response from the DescribeVpcPeeringAuthorizations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringAuthorizations Operation - - - - Retrieves valid VPC peering authorizations that are pending for the AWS account. This - operation returns all VPC peering authorizations and requests for peering. This includes - those initiated and received by this account. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringAuthorizations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeVpcPeeringAuthorizations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringAuthorizations Operation - - - - Retrieves information on VPC peering connections. Use this operation to get peering - information for all fleets or for one specific fleet ID. - - - - To retrieve connection information, call this operation from the AWS account that - is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter - empty to retrieve all connection records. If successful, the retrieved information - includes both active and pending connections. Active connections identify the IpV4 - CIDR block that the VPC uses to connect. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method. - - The response from the DescribeVpcPeeringConnections service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringConnections Operation - - - - Retrieves information on VPC peering connections. Use this operation to get peering - information for all fleets or for one specific fleet ID. - - - - To retrieve connection information, call this operation from the AWS account that - is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter - empty to retrieve all connection records. If successful, the retrieved information - includes both active and pending connections. Active connections identify the IpV4 - CIDR block that the VPC uses to connect. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeVpcPeeringConnections service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringConnections Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - A unique identifier for the game session to get logs for. - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the GetGameSessionLogUrl service method. - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - A unique identifier for the game session to get logs for. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the GetGameSessionLogUrl service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Requests remote access to a fleet instance. Remote access is useful for debugging, - gathering benchmarking data, or observing activity in real time. - - - - To remotely access an instance, you need credentials that match the operating system - of the instance. For a Windows instance, GameLift returns a user name and password - as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - returns a user name and RSA private key, also as strings, for use with an SSH client. - The private key must be saved in the proper format to a .pem file before - using. If you're making this request using the AWS CLI, saving the secret can be handled - as part of the GetInstanceAccess request, as shown in one of the examples - for this operation. - - - - To request access to a specific instance, specify the IDs of both the instance and - the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. - If successful, an InstanceAccess object is returned that contains the instance's - IP address and a set of credentials. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the GetInstanceAccess service method. - - The response from the GetInstanceAccess service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetInstanceAccess Operation - - - - Requests remote access to a fleet instance. Remote access is useful for debugging, - gathering benchmarking data, or observing activity in real time. - - - - To remotely access an instance, you need credentials that match the operating system - of the instance. For a Windows instance, GameLift returns a user name and password - as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - returns a user name and RSA private key, also as strings, for use with an SSH client. - The private key must be saved in the proper format to a .pem file before - using. If you're making this request using the AWS CLI, saving the secret can be handled - as part of the GetInstanceAccess request, as shown in one of the examples - for this operation. - - - - To request access to a specific instance, specify the IDs of both the instance and - the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. - If successful, an InstanceAccess object is returned that contains the instance's - IP address and a set of credentials. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the GetInstanceAccess service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetInstanceAccess service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetInstanceAccess Operation - - - - Retrieves all aliases for this AWS account. You can filter the result set by alias - name and/or routing strategy type. Use the pagination parameters to retrieve results - in sequential pages. - - - - Returned aliases are not listed in any particular order. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ListAliases service method. - - The response from the ListAliases service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListAliases Operation - - - - Retrieves all aliases for this AWS account. You can filter the result set by alias - name and/or routing strategy type. Use the pagination parameters to retrieve results - in sequential pages. - - - - Returned aliases are not listed in any particular order. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ListAliases service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListAliases service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListAliases Operation - - - - Retrieves build resources for all builds associated with the AWS account in use. You - can limit results to builds that are in a specific status by using the Status - parameter. Use the pagination parameters to retrieve results in a set of sequential - pages. - - - - Build resources are not listed in any particular order. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the ListBuilds service method. - - The response from the ListBuilds service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListBuilds Operation - - - - Retrieves build resources for all builds associated with the AWS account in use. You - can limit results to builds that are in a specific status by using the Status - parameter. Use the pagination parameters to retrieve results in a set of sequential - pages. - - - - Build resources are not listed in any particular order. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the ListBuilds service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuilds service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListBuilds Operation - - - - Retrieves a collection of fleet resources in an AWS Region. You can call this operation - to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - specify a Region in your request. You can filter the result set to find only those - fleets that are deployed with a specific build or script. For fleets that have multiple - locations, this operation retrieves fleets based on their home Region only. - - - - This operation can be used in the following ways: - -
  • - - To get a list of all fleets in a Region, don't provide a build or script identifier. - - -
  • - - To get a list of all fleets where a specific custom game build is deployed, provide - the build ID. - -
  • - - To get a list of all Realtime Servers fleets with a specific configuration script, - provide the script ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a list of fleet IDs that match the request parameters is returned. - A NextToken value is also returned if there are more result pages to retrieve. - - - - Fleet resources are not listed in a particular order. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the ListFleets service method. - - The response from the ListFleets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListFleets Operation - - - - Retrieves a collection of fleet resources in an AWS Region. You can call this operation - to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - specify a Region in your request. You can filter the result set to find only those - fleets that are deployed with a specific build or script. For fleets that have multiple - locations, this operation retrieves fleets based on their home Region only. - - - - This operation can be used in the following ways: - -
  • - - To get a list of all fleets in a Region, don't provide a build or script identifier. - - -
  • - - To get a list of all fleets where a specific custom game build is deployed, provide - the build ID. - -
  • - - To get a list of all Realtime Servers fleets with a specific configuration script, - provide the script ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a list of fleet IDs that match the request parameters is returned. - A NextToken value is also returned if there are more result pages to retrieve. - - - - Fleet resources are not listed in a particular order. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the ListFleets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListFleets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListFleets Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers groups that exist in the current AWS account - for the selected Region. Use the pagination parameters to retrieve results in a set - of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServerGroups service method. - - The response from the ListGameServerGroups service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServerGroups Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers groups that exist in the current AWS account - for the selected Region. Use the pagination parameters to retrieve results in a set - of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServerGroups service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGameServerGroups service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServerGroups Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers that are currently active in a specified - game server group. You can opt to sort the list by game server age. Use the pagination - parameters to retrieve results in a set of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServers service method. - - The response from the ListGameServers service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServers Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers that are currently active in a specified - game server group. You can opt to sort the list by game server age. Use the pagination - parameters to retrieve results in a set of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGameServers service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServers Operation - - - - Retrieves script records for all Realtime scripts that are associated with the AWS - account in use. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the ListScripts service method. - - The response from the ListScripts service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListScripts Operation - - - - Retrieves script records for all Realtime scripts that are associated with the AWS - account in use. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the ListScripts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListScripts service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListScripts Operation - - - - Retrieves all tags that are assigned to a GameLift resource. Resource tags are used - to organize AWS resources for a range of purposes. This operation handles the permissions - necessary to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To list tags for a resource, specify the unique ARN value for the resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - The response from the ListTagsForResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for ListTagsForResource Operation - - - - Retrieves all tags that are assigned to a GameLift resource. Resource tags are used - to organize AWS resources for a range of purposes. This operation handles the permissions - necessary to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To list tags for a resource, specify the unique ARN value for the resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTagsForResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for ListTagsForResource Operation - - - - Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically - scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs - Amazon GameLift to track a fleet metric and automatically change the fleet's capacity - when a certain threshold is reached. There are two types of scaling policies: target-based - and rule-based. Use a target-based policy to quickly and efficiently manage fleet - scaling; this option is the most commonly used. Use rule-based policies when you need - to exert fine-grained control over auto-scaling. - - - - Fleets can have multiple scaling policies of each type in force at the same time; - you can have one target-based policy, one or multiple rule-based scaling policies, - or both. We recommend caution, however, because multiple auto-scaling policies can - have unintended consequences. - - - - You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions - with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions - with the same fleet action. To stop just one scaling policy--or to permanently remove - it, you must delete the policy with DeleteScalingPolicy. - - - - Learn more about how to work with auto-scaling in Set - Up Fleet Automatic Scaling. - - - - Target-based policy - - - - A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric - tells us how much of a fleet's hosting capacity is ready to host game sessions but - is not currently in use. This is the fleet's buffer; it measures the additional player - demand that the fleet could handle at current capacity. With a target-based policy, - you set your ideal buffer size and leave it to Amazon GameLift to take whatever action - is needed to maintain that target. - - - - For example, you might choose to maintain a 10% buffer for a fleet that has the capacity - to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take - action whenever the fleet's available capacity falls below or rises above 10 game - sessions. Amazon GameLift will start new instances or stop unused instances in order - to return to the 10% buffer. - - - - To create or update a target-based policy, specify a fleet ID and name, and set the - policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - and reference a TargetConfiguration object with your desired buffer value. - Exclude all other parameters. On a successful request, the policy name is returned. - The scaling policy is automatically in force as soon as it's successfully created. - If the fleet's auto-scaling actions are temporarily suspended, the new policy will - be in force once the fleet actions are restarted. - - - - Rule-based policy - - - - A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies - the type of action to initiate when triggered. With a rule-based policy, you can select - from several available fleet metrics. Each policy specifies whether to scale up or - scale down (and by how much), so you need one policy for each type of action. - - - - For example, a policy may make the following statement: "If the percentage of idle - instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - by 10%." - - - - A policy's rule statement has the following structure: - - - - If [MetricName] is [ComparisonOperator] [Threshold] - for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] - to/by [ScalingAdjustment]. - - - - To implement the example, the rule statement would look like this: - - - - If [PercentIdleInstances] is [GreaterThanThreshold] [20] - for [15] minutes, then [PercentChangeInCapacity] to/by [10]. - - - - To create or update a scaling policy, specify a unique combination of name and fleet - ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - rule statement. On a successful request, the policy name is returned. Scaling policies - are automatically in force as soon as they're successfully created. If the fleet's - auto-scaling actions are temporarily suspended, the new policy will be in force once - the fleet actions are restarted. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the PutScalingPolicy service method. - - The response from the PutScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for PutScalingPolicy Operation - - - - Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically - scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs - Amazon GameLift to track a fleet metric and automatically change the fleet's capacity - when a certain threshold is reached. There are two types of scaling policies: target-based - and rule-based. Use a target-based policy to quickly and efficiently manage fleet - scaling; this option is the most commonly used. Use rule-based policies when you need - to exert fine-grained control over auto-scaling. - - - - Fleets can have multiple scaling policies of each type in force at the same time; - you can have one target-based policy, one or multiple rule-based scaling policies, - or both. We recommend caution, however, because multiple auto-scaling policies can - have unintended consequences. - - - - You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions - with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions - with the same fleet action. To stop just one scaling policy--or to permanently remove - it, you must delete the policy with DeleteScalingPolicy. - - - - Learn more about how to work with auto-scaling in Set - Up Fleet Automatic Scaling. - - - - Target-based policy - - - - A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric - tells us how much of a fleet's hosting capacity is ready to host game sessions but - is not currently in use. This is the fleet's buffer; it measures the additional player - demand that the fleet could handle at current capacity. With a target-based policy, - you set your ideal buffer size and leave it to Amazon GameLift to take whatever action - is needed to maintain that target. - - - - For example, you might choose to maintain a 10% buffer for a fleet that has the capacity - to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take - action whenever the fleet's available capacity falls below or rises above 10 game - sessions. Amazon GameLift will start new instances or stop unused instances in order - to return to the 10% buffer. - - - - To create or update a target-based policy, specify a fleet ID and name, and set the - policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - and reference a TargetConfiguration object with your desired buffer value. - Exclude all other parameters. On a successful request, the policy name is returned. - The scaling policy is automatically in force as soon as it's successfully created. - If the fleet's auto-scaling actions are temporarily suspended, the new policy will - be in force once the fleet actions are restarted. - - - - Rule-based policy - - - - A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies - the type of action to initiate when triggered. With a rule-based policy, you can select - from several available fleet metrics. Each policy specifies whether to scale up or - scale down (and by how much), so you need one policy for each type of action. - - - - For example, a policy may make the following statement: "If the percentage of idle - instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - by 10%." - - - - A policy's rule statement has the following structure: - - - - If [MetricName] is [ComparisonOperator] [Threshold] - for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] - to/by [ScalingAdjustment]. - - - - To implement the example, the rule statement would look like this: - - - - If [PercentIdleInstances] is [GreaterThanThreshold] [20] - for [15] minutes, then [PercentChangeInCapacity] to/by [10]. - - - - To create or update a scaling policy, specify a unique combination of name and fleet - ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - rule statement. On a successful request, the policy name is returned. Scaling policies - are automatically in force as soon as they're successfully created. If the fleet's - auto-scaling actions are temporarily suspended, the new policy will be in force once - the fleet actions are restarted. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the PutScalingPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for PutScalingPolicy Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a new game server resource and notifies GameLift FleetIQ that the game server - is ready to host gameplay and players. This operation is called by a game server process - that is running on an instance in a game server group. Registering game servers enables - GameLift FleetIQ to track available game servers and enables game clients and services - to claim a game server for a new game session. - - - - To register a game server, identify the game server group and instance where the game - server is running, and provide a unique identifier for the game server. You can also - include connection and game server data. When a game client or service requests a - game server by calling ClaimGameServer, this information is returned in the - response. - - - - Once a game server is successfully registered, it is put in status AVAILABLE. - A request to register a game server may fail if the instance it is running on is in - the process of shutting down as part of instance balancing or scale-down activity. - - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the RegisterGameServer service method. - - The response from the RegisterGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RegisterGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a new game server resource and notifies GameLift FleetIQ that the game server - is ready to host gameplay and players. This operation is called by a game server process - that is running on an instance in a game server group. Registering game servers enables - GameLift FleetIQ to track available game servers and enables game clients and services - to claim a game server for a new game session. - - - - To register a game server, identify the game server group and instance where the game - server is running, and provide a unique identifier for the game server. You can also - include connection and game server data. When a game client or service requests a - game server by calling ClaimGameServer, this information is returned in the - response. - - - - Once a game server is successfully registered, it is put in status AVAILABLE. - A request to register a game server may fail if the instance it is running on is in - the process of shutting down as part of instance balancing or scale-down activity. - - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the RegisterGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RegisterGameServer Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the RequestUploadCredentials service method. - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the RequestUploadCredentials service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value. - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ResolveAlias service method. - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ResolveAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Reinstates activity on a game server group after it has been suspended. A game server - group might be suspended by theSuspendGameServerGroup operation, or it might - be suspended involuntarily due to a configuration problem. In the second case, you - can manually resume activity on the group once the configuration problem has been - resolved. Refer to the game server group status and status reason for more information - on why group activity is suspended. - - - - To resume activity, specify a game server group ARN and the type of activity to be - resumed. If successful, a GameServerGroup object is returned showing that the - resumed activity is no longer listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ResumeGameServerGroup service method. - - The response from the ResumeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResumeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Reinstates activity on a game server group after it has been suspended. A game server - group might be suspended by theSuspendGameServerGroup operation, or it might - be suspended involuntarily due to a configuration problem. In the second case, you - can manually resume activity on the group once the configuration problem has been - resolved. Refer to the game server group status and status reason for more information - on why group activity is suspended. - - - - To resume activity, specify a game server group ARN and the type of activity to be - resumed. If successful, a GameServerGroup object is returned showing that the - resumed activity is no longer listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ResumeGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResumeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResumeGameServerGroup Operation - - - - Retrieves all active game sessions that match a set of search criteria and sorts them - into a specified order. - - - - When searching for game sessions, you specify exactly where you want to search and - provide a search filter expression, a sort expression, or both. A search request can - search only one fleet, but it can search all of a fleet's locations. - - - - This operation can be used in the following ways: - -
  • - - To search all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID. This approach returns game sessions in the fleet's home - Region and all remote locations that fit the search criteria. - -
  • - - To search all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name. For location, you can specify a fleet's - home Region or any remote location. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. Search finds game sessions that are in ACTIVE - status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. - - - - You can search or sort by the following game session attributes: - -
  • - - gameSessionId -- A unique identifier for the game session. You can use either - a GameSessionId or GameSessionArn value. - -
  • - - gameSessionName -- Name assigned to a game session. This value is set when - requesting a new game session with CreateGameSession or updating with UpdateGameSession. - Game session names do not need to be unique to a game session. - -
  • - - gameSessionProperties -- Custom data defined in a game session's GameProperty - parameter. GameProperty values are stored as key:value pairs; the filter - expression must indicate the key and a string to search the data values for. For example, - to search for game sessions with custom data containing the key:value pair "gameMode:brawl", - specify the following: gameSessionProperties.gameMode = "brawl". All - custom data values are searched as strings. - -
  • - - maximumSessions -- Maximum number of player sessions allowed for a game session. - This value is set when requesting a new game session with CreateGameSession - or updating with UpdateGameSession. - -
  • - - creationTimeMillis -- Value indicating when a game session was created. It - is expressed in Unix time as milliseconds. - -
  • - - playerSessionCount -- Number of players currently connected to a game session. - This value changes rapidly as players join the session or drop out. - -
  • - - hasAvailablePlayerSessions -- Boolean value indicating whether a game session - has reached its maximum number of players. It is highly recommended that all search - requests include this filter attribute to optimize search performance and return only - sessions that players can join. - -
- - Returned values for playerSessionCount and hasAvailablePlayerSessions - change quickly as players join sessions and others drop out. Results should be considered - a snapshot in time. Be sure to refresh search results often, and handle sessions that - fill up before a player can join. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the SearchGameSessions service method. - - The response from the SearchGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SearchGameSessions Operation - - - - Retrieves all active game sessions that match a set of search criteria and sorts them - into a specified order. - - - - When searching for game sessions, you specify exactly where you want to search and - provide a search filter expression, a sort expression, or both. A search request can - search only one fleet, but it can search all of a fleet's locations. - - - - This operation can be used in the following ways: - -
  • - - To search all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID. This approach returns game sessions in the fleet's home - Region and all remote locations that fit the search criteria. - -
  • - - To search all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name. For location, you can specify a fleet's - home Region or any remote location. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. Search finds game sessions that are in ACTIVE - status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. - - - - You can search or sort by the following game session attributes: - -
  • - - gameSessionId -- A unique identifier for the game session. You can use either - a GameSessionId or GameSessionArn value. - -
  • - - gameSessionName -- Name assigned to a game session. This value is set when - requesting a new game session with CreateGameSession or updating with UpdateGameSession. - Game session names do not need to be unique to a game session. - -
  • - - gameSessionProperties -- Custom data defined in a game session's GameProperty - parameter. GameProperty values are stored as key:value pairs; the filter - expression must indicate the key and a string to search the data values for. For example, - to search for game sessions with custom data containing the key:value pair "gameMode:brawl", - specify the following: gameSessionProperties.gameMode = "brawl". All - custom data values are searched as strings. - -
  • - - maximumSessions -- Maximum number of player sessions allowed for a game session. - This value is set when requesting a new game session with CreateGameSession - or updating with UpdateGameSession. - -
  • - - creationTimeMillis -- Value indicating when a game session was created. It - is expressed in Unix time as milliseconds. - -
  • - - playerSessionCount -- Number of players currently connected to a game session. - This value changes rapidly as players join the session or drop out. - -
  • - - hasAvailablePlayerSessions -- Boolean value indicating whether a game session - has reached its maximum number of players. It is highly recommended that all search - requests include this filter attribute to optimize search performance and return only - sessions that players can join. - -
- - Returned values for playerSessionCount and hasAvailablePlayerSessions - change quickly as players join sessions and others drop out. Results should be considered - a snapshot in time. Be sure to refresh search results often, and handle sessions that - fill up before a player can join. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the SearchGameSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SearchGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SearchGameSessions Operation - - - - Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. - For multi-location fleets, fleet actions are managed separately for each location. - Currently, this operation is used to restart a fleet's auto-scaling activity. - - - - This operation can be used in the following ways: - -
  • - - To restart actions on instances in the fleet's home Region, provide a fleet ID and - the type of actions to resume. - -
  • - - To restart actions on instances in one of the fleet's remote locations, provide a - fleet ID, a location name, and the type of actions to resume. - -
- - If successful, GameLift once again initiates scaling events as triggered by the fleet's - scaling policies. If actions on the fleet location were never stopped, this operation - will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes - or DescribeFleetLocationAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StartFleetActions service method. - - The response from the StartFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartFleetActions Operation - - - - Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. - For multi-location fleets, fleet actions are managed separately for each location. - Currently, this operation is used to restart a fleet's auto-scaling activity. - - - - This operation can be used in the following ways: - -
  • - - To restart actions on instances in the fleet's home Region, provide a fleet ID and - the type of actions to resume. - -
  • - - To restart actions on instances in one of the fleet's remote locations, provide a - fleet ID, a location name, and the type of actions to resume. - -
- - If successful, GameLift once again initiates scaling events as triggered by the fleet's - scaling policies. If actions on the fleet location were never stopped, this operation - will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes - or DescribeFleetLocationAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StartFleetActions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartFleetActions Operation - - - - Places a request for a new game session in a queue (see CreateGameSessionQueue). - When processing a placement request, Amazon GameLift searches for available resources - on the queue's destinations, scanning each until it finds resources or the placement - request times out. - - - - A game session placement request can also request player sessions. When a new game - session is successfully created, Amazon GameLift creates a player session for each - player included in the request. - - - - When placing a game session, by default Amazon GameLift tries each fleet in the order - they are listed in the queue configuration. Ideally, a queue's destinations are listed - in preference order. - - - - Alternatively, when requesting a game session with players, you can also provide latency - data for each player in relevant Regions. Latency data indicates the performance lag - a player experiences when connected to a fleet in the Region. Amazon GameLift uses - latency data to reorder the list of destinations to place the game session in a Region - with minimal lag. If latency data is provided for multiple players, Amazon GameLift - calculates each Region's average lag for all players and reorders to get the best - game play across all players. - - - - To place a new game session request, specify the following: - -
  • - - The queue name and a set of game session properties and settings - -
  • - - A unique ID (such as a UUID) for the placement. You use this ID to track the status - of the placement request - -
  • - - (Optional) A set of player data and a unique player ID for each player that you are - joining to the new game session (player data is optional, but if you include it, you - must also provide a unique ID for each player) - -
  • - - Latency data for all players (if you want to optimize game play for the players) - -
- - If successful, a new game session placement is created. - - - - To track the status of a placement request, call DescribeGameSessionPlacement - and check the request's status. If the status is FULFILLED, a new game - session has been created and a game session ARN and Region are referenced. If the - placement request times out, you can resubmit the request or retry it with a different - queue. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StartGameSessionPlacement service method. - - The response from the StartGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartGameSessionPlacement Operation - - - - Places a request for a new game session in a queue (see CreateGameSessionQueue). - When processing a placement request, Amazon GameLift searches for available resources - on the queue's destinations, scanning each until it finds resources or the placement - request times out. - - - - A game session placement request can also request player sessions. When a new game - session is successfully created, Amazon GameLift creates a player session for each - player included in the request. - - - - When placing a game session, by default Amazon GameLift tries each fleet in the order - they are listed in the queue configuration. Ideally, a queue's destinations are listed - in preference order. - - - - Alternatively, when requesting a game session with players, you can also provide latency - data for each player in relevant Regions. Latency data indicates the performance lag - a player experiences when connected to a fleet in the Region. Amazon GameLift uses - latency data to reorder the list of destinations to place the game session in a Region - with minimal lag. If latency data is provided for multiple players, Amazon GameLift - calculates each Region's average lag for all players and reorders to get the best - game play across all players. - - - - To place a new game session request, specify the following: - -
  • - - The queue name and a set of game session properties and settings - -
  • - - A unique ID (such as a UUID) for the placement. You use this ID to track the status - of the placement request - -
  • - - (Optional) A set of player data and a unique player ID for each player that you are - joining to the new game session (player data is optional, but if you include it, you - must also provide a unique ID for each player) - -
  • - - Latency data for all players (if you want to optimize game play for the players) - -
- - If successful, a new game session placement is created. - - - - To track the status of a placement request, call DescribeGameSessionPlacement - and check the request's status. If the status is FULFILLED, a new game - session has been created and a game session ARN and Region are referenced. If the - placement request times out, you can resubmit the request or retry it with a different - queue. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StartGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartGameSessionPlacement Operation - - - - Finds new players to fill open slots in currently running game sessions. The backfill - match process is essentially identical to the process of forming new matches. Backfill - requests use the same matchmaker that was used to make the original match, and they - provide matchmaking data for all players currently in the game session. FlexMatch - uses this information to select new players so that backfilled match continues to - meet the original match requirements. - - - - When using FlexMatch with GameLift managed hosting, you can request a backfill match - from a client service by calling this operation with a GameSession identifier. - You also have the option of making backfill requests directly from your game server. - In response to a request, FlexMatch creates player sessions for the new players, updates - the GameSession resource, and sends updated matchmaking data to the game - server. You can request a backfill match at any point after a game session is started. - Each game session can have only one active backfill request at a time; a subsequent - request automatically replaces the earlier request. - - - - When using FlexMatch as a standalone component, request a backfill match by calling - this operation without a game session identifier. As with newly formed matches, matchmaking - results are returned in a matchmaking event so that your game can update the game - session that is being backfilled. - - - - To request a backfill match, specify a unique ticket ID, the original matchmaking - configuration, and matchmaking data for all current players in the game session being - backfilled. Optionally, specify the GameSession ARN. If successful, a - match backfill ticket is created and returned with status set to QUEUED. Track the - status of backfill tickets using the same method for tracking tickets for new matches. - - - - Learn more - - - - - Backfill existing games with FlexMatch - - - - - Matchmaking events (reference) - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchBackfill service method. - - The response from the StartMatchBackfill service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchBackfill Operation - - - - Finds new players to fill open slots in currently running game sessions. The backfill - match process is essentially identical to the process of forming new matches. Backfill - requests use the same matchmaker that was used to make the original match, and they - provide matchmaking data for all players currently in the game session. FlexMatch - uses this information to select new players so that backfilled match continues to - meet the original match requirements. - - - - When using FlexMatch with GameLift managed hosting, you can request a backfill match - from a client service by calling this operation with a GameSession identifier. - You also have the option of making backfill requests directly from your game server. - In response to a request, FlexMatch creates player sessions for the new players, updates - the GameSession resource, and sends updated matchmaking data to the game - server. You can request a backfill match at any point after a game session is started. - Each game session can have only one active backfill request at a time; a subsequent - request automatically replaces the earlier request. - - - - When using FlexMatch as a standalone component, request a backfill match by calling - this operation without a game session identifier. As with newly formed matches, matchmaking - results are returned in a matchmaking event so that your game can update the game - session that is being backfilled. - - - - To request a backfill match, specify a unique ticket ID, the original matchmaking - configuration, and matchmaking data for all current players in the game session being - backfilled. Optionally, specify the GameSession ARN. If successful, a - match backfill ticket is created and returned with status set to QUEUED. Track the - status of backfill tickets using the same method for tracking tickets for new matches. - - - - Learn more - - - - - Backfill existing games with FlexMatch - - - - - Matchmaking events (reference) - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchBackfill service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartMatchBackfill service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchBackfill Operation - - - - Uses FlexMatch to create a game match for a group of players based on custom matchmaking - rules. With games that use GameLift managed hosting, this operation also triggers - GameLift to find hosting resources and start a new game session for the new match. - Each matchmaking request includes information on one or more players and specifies - the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch - attempts to build a match that includes all players in the request, placing them in - the same team and finding additional players as needed to fill the match. - - - - To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - and include the players to be matched. You must also include any player attributes - that are required by the matchmaking configuration's rule set. If successful, a matchmaking - ticket is returned with status set to QUEUED. - - - - Track matchmaking events to respond as needed and acquire game session connection - information for successfully completed matches. Ticket status updates are tracked - using event notification through Amazon Simple Notification Service (SNS), which is - defined in the matchmaking configuration. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchmaking service method. - - The response from the StartMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchmaking Operation - - - - Uses FlexMatch to create a game match for a group of players based on custom matchmaking - rules. With games that use GameLift managed hosting, this operation also triggers - GameLift to find hosting resources and start a new game session for the new match. - Each matchmaking request includes information on one or more players and specifies - the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch - attempts to build a match that includes all players in the request, placing them in - the same team and finding additional players as needed to fill the match. - - - - To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - and include the players to be matched. You must also include any player attributes - that are required by the matchmaking configuration's rule set. If successful, a matchmaking - ticket is returned with status set to QUEUED. - - - - Track matchmaking events to respond as needed and acquire game session connection - information for successfully completed matches. Ticket status updates are tracked - using event notification through Amazon Simple Notification Service (SNS), which is - defined in the matchmaking configuration. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchmaking Operation - - - - Suspends certain types of activity in a fleet location. Currently, this operation - is used to stop auto-scaling activity. For multi-location fleets, fleet actions are - managed separately for each location. - - - - Stopping fleet actions has several potential purposes. It allows you to temporarily - stop auto-scaling activity but retain your scaling policies for use in the future. - For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out - of it for certain locations. - - - - This operation can be used in the following ways: - -
  • - - To stop actions on instances in the fleet's home Region, provide a fleet ID and the - type of actions to suspend. - -
  • - - To stop actions on instances in one of the fleet's remote locations, provide a fleet - ID, a location name, and the type of actions to suspend. - -
- - If successful, GameLift no longer initiates scaling events except in response to manual - changes using UpdateFleetCapacity. You can view a fleet's stopped actions using - DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended - activity can be restarted using StartFleetActions. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StopFleetActions service method. - - The response from the StopFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopFleetActions Operation - - - - Suspends certain types of activity in a fleet location. Currently, this operation - is used to stop auto-scaling activity. For multi-location fleets, fleet actions are - managed separately for each location. - - - - Stopping fleet actions has several potential purposes. It allows you to temporarily - stop auto-scaling activity but retain your scaling policies for use in the future. - For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out - of it for certain locations. - - - - This operation can be used in the following ways: - -
  • - - To stop actions on instances in the fleet's home Region, provide a fleet ID and the - type of actions to suspend. - -
  • - - To stop actions on instances in one of the fleet's remote locations, provide a fleet - ID, a location name, and the type of actions to suspend. - -
- - If successful, GameLift no longer initiates scaling events except in response to manual - changes using UpdateFleetCapacity. You can view a fleet's stopped actions using - DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended - activity can be restarted using StartFleetActions. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StopFleetActions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopFleetActions Operation - - - - Cancels a game session placement that is in PENDING status. To stop a - placement, provide the placement ID values. If successful, the placement is moved - to CANCELLED status. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StopGameSessionPlacement service method. - - The response from the StopGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopGameSessionPlacement Operation - - - - Cancels a game session placement that is in PENDING status. To stop a - placement, provide the placement ID values. If successful, the placement is moved - to CANCELLED status. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StopGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopGameSessionPlacement Operation - - - - Cancels a matchmaking ticket or match backfill ticket that is currently being processed. - To stop the matchmaking operation, specify the ticket ID. If successful, work on the - ticket is stopped, and the ticket status is changed to CANCELLED. - - - - This call is also used to turn off automatic backfill for an individual game session. - This is for game sessions that are created with a matchmaking configuration that has - automatic backfill enabled. The ticket ID is included in the MatchmakerData - of an updated game session object, which is provided to the game server. - - - - If the operation is successful, the service sends back an empty JSON struct with the - HTTP 200 response (not an empty HTTP body). - - - - Learn more - - - - - Add FlexMatch to a game client - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StopMatchmaking service method. - - The response from the StopMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StopMatchmaking Operation - - - - Cancels a matchmaking ticket or match backfill ticket that is currently being processed. - To stop the matchmaking operation, specify the ticket ID. If successful, work on the - ticket is stopped, and the ticket status is changed to CANCELLED. - - - - This call is also used to turn off automatic backfill for an individual game session. - This is for game sessions that are created with a matchmaking configuration that has - automatic backfill enabled. The ticket ID is included in the MatchmakerData - of an updated game session object, which is provided to the game server. - - - - If the operation is successful, the service sends back an empty JSON struct with the - HTTP 200 response (not an empty HTTP body). - - - - Learn more - - - - - Add FlexMatch to a game client - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StopMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StopMatchmaking Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Temporarily stops activity on a game server group without terminating instances or - the game server group. You can restart activity by calling ResumeGameServerGroup. - You can suspend the following activity: - -
  • - - Instance type replacement - This activity evaluates the current game hosting - viability of all Spot instance types that are defined for the game server group. It - updates the Auto Scaling group to remove nonviable Spot Instance types, which have - a higher chance of game server interruptions. It then balances capacity across the - remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling - group continues with its current balance, regardless of viability. Instance protection, - utilization metrics, and capacity scaling activities continue to be active. - -
- - To suspend activity, specify a game server group ARN and the type of activity to be - suspended. If successful, a GameServerGroup object is returned showing that - the activity is listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the SuspendGameServerGroup service method. - - The response from the SuspendGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SuspendGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Temporarily stops activity on a game server group without terminating instances or - the game server group. You can restart activity by calling ResumeGameServerGroup. - You can suspend the following activity: - -
  • - - Instance type replacement - This activity evaluates the current game hosting - viability of all Spot instance types that are defined for the game server group. It - updates the Auto Scaling group to remove nonviable Spot Instance types, which have - a higher chance of game server interruptions. It then balances capacity across the - remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling - group continues with its current balance, regardless of viability. Instance protection, - utilization metrics, and capacity scaling activities continue to be active. - -
- - To suspend activity, specify a game server group ARN and the type of activity to be - suspended. If successful, a GameServerGroup object is returned showing that - the activity is listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the SuspendGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SuspendGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SuspendGameServerGroup Operation - - - - Assigns a tag to a GameLift resource. AWS resource tags provide an additional management - tool set. You can use tags to organize resources, create IAM permissions policies - to manage access to groups of resources, customize AWS cost breakdowns, etc. This - operation handles the permissions necessary to manage tags for the following GameLift - resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To add a tag to a resource, specify the unique ARN value for the resource and provide - a tag list containing one or more tags. The operation succeeds even if the list includes - tags that are already assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the TagResource service method. - - The response from the TagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for TagResource Operation - - - - Assigns a tag to a GameLift resource. AWS resource tags provide an additional management - tool set. You can use tags to organize resources, create IAM permissions policies - to manage access to groups of resources, customize AWS cost breakdowns, etc. This - operation handles the permissions necessary to manage tags for the following GameLift - resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To add a tag to a resource, specify the unique ARN value for the resource and provide - a tag list containing one or more tags. The operation succeeds even if the list includes - tags that are already assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the TagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for TagResource Operation - - - - Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize - AWS resources for a range of purposes. This operation handles the permissions necessary - to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To remove a tag from a resource, specify the unique ARN value for the resource and - provide a string list containing one or more tags to be removed. This operation succeeds - even if the list includes tags that are not currently assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the UntagResource service method. - - The response from the UntagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for UntagResource Operation - - - - Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize - AWS resources for a range of purposes. This operation handles the permissions necessary - to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To remove a tag from a resource, specify the unique ARN value for the resource and - provide a string list containing one or more tags to be removed. This operation succeeds - even if the list includes tags that are not currently assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the UntagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UntagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for UntagResource Operation - - - - Updates properties for an alias. To update properties, specify the alias ID to be - updated and provide the information to be changed. To reassign an alias to another - fleet, provide an updated routing strategy. If successful, the updated alias record - is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the UpdateAlias service method. - - The response from the UpdateAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateAlias Operation - - - - Updates properties for an alias. To update properties, specify the alias ID to be - updated and provide the information to be changed. To reassign an alias to another - fleet, provide an updated routing strategy. If successful, the updated alias record - is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the UpdateAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateAlias Operation - - - - Updates metadata in a build resource, including the build name and version. To update - the metadata, specify the build ID to update and provide the new values. If successful, - a build object containing the updated metadata is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the UpdateBuild service method. - - The response from the UpdateBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateBuild Operation - - - - Updates metadata in a build resource, including the build name and version. To update - the metadata, specify the build ID to update and provide the new values. If successful, - a build object containing the updated metadata is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the UpdateBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateBuild Operation - - - - Updates a fleet's mutable attributes, including game session protection and resource - creation limits. - - - - To update fleet attributes, specify the fleet ID and the property values that you - want to change. - - - - If successful, an updated FleetAttributes object is returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetAttributes service method. - - The response from the UpdateFleetAttributes service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetAttributes Operation - - - - Updates a fleet's mutable attributes, including game session protection and resource - creation limits. - - - - To update fleet attributes, specify the fleet ID and the property values that you - want to change. - - - - If successful, an updated FleetAttributes object is returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetAttributes service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetAttributes Operation - - - - Updates capacity settings for a fleet. For fleets with multiple locations, use this - operation to manage capacity settings in each location individually. Fleet capacity - determines the number of game sessions and players that can be hosted based on the - fleet configuration. Use this operation to set the following fleet capacity properties: - - -
  • - - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's - capacity to a value outside of this range, whether the capacity is changed manually - or through automatic scaling. - -
  • - - Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet - location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits - to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider - using automatic scaling to adjust capacity based on player demand. - -
- - This operation can be used in the following ways: - -
  • - - To update capacity for a fleet's home Region, or if the fleet has no remote locations, - omit the Location parameter. The fleet must be in ACTIVE - status. - -
  • - - To update capacity for a fleet's remote location, include the Location - parameter set to the location to be updated. The location must be in ACTIVE - status. - -
- - If successful, capacity settings are updated immediately. In response a change in - desired capacity, GameLift initiates steps to start new instances or terminate existing - instances in the requested fleet location. This continues until the location's active - instance count matches the new desired instance count. You can track a fleet's current - capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. - If the requested desired instance count is higher than the instance type's limit, - the LimitExceeded exception occurs. - - - - Learn more - - - - Scaling - fleet capacity - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetCapacity service method. - - The response from the UpdateFleetCapacity service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetCapacity Operation - - - - Updates capacity settings for a fleet. For fleets with multiple locations, use this - operation to manage capacity settings in each location individually. Fleet capacity - determines the number of game sessions and players that can be hosted based on the - fleet configuration. Use this operation to set the following fleet capacity properties: - - -
  • - - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's - capacity to a value outside of this range, whether the capacity is changed manually - or through automatic scaling. - -
  • - - Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet - location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits - to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider - using automatic scaling to adjust capacity based on player demand. - -
- - This operation can be used in the following ways: - -
  • - - To update capacity for a fleet's home Region, or if the fleet has no remote locations, - omit the Location parameter. The fleet must be in ACTIVE - status. - -
  • - - To update capacity for a fleet's remote location, include the Location - parameter set to the location to be updated. The location must be in ACTIVE - status. - -
- - If successful, capacity settings are updated immediately. In response a change in - desired capacity, GameLift initiates steps to start new instances or terminate existing - instances in the requested fleet location. This continues until the location's active - instance count matches the new desired instance count. You can track a fleet's current - capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. - If the requested desired instance count is higher than the instance type's limit, - the LimitExceeded exception occurs. - - - - Learn more - - - - Scaling - fleet capacity - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetCapacity service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetCapacity Operation - - - - Updates permissions that allow inbound traffic to connect to game sessions that are - being hosted on instances in the fleet. - - - - To update settings, specify the fleet ID to be updated and specify the changes to - be made. List the permissions you want to add in InboundPermissionAuthorizations, - and permissions you want to remove in InboundPermissionRevocations. Permissions - to be removed must match existing fleet permissions. - - - - If successful, the fleet ID for the updated fleet is returned. For fleets with remote - locations, port setting updates can take time to propagate across all locations. You - can check the status of updates in each location by calling DescribeFleetPortSettings - with a location name. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetPortSettings service method. - - The response from the UpdateFleetPortSettings service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetPortSettings Operation - - - - Updates permissions that allow inbound traffic to connect to game sessions that are - being hosted on instances in the fleet. - - - - To update settings, specify the fleet ID to be updated and specify the changes to - be made. List the permissions you want to add in InboundPermissionAuthorizations, - and permissions you want to remove in InboundPermissionRevocations. Permissions - to be removed must match existing fleet permissions. - - - - If successful, the fleet ID for the updated fleet is returned. For fleets with remote - locations, port setting updates can take time to propagate across all locations. You - can check the status of updates in each location by calling DescribeFleetPortSettings - with a location name. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetPortSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetPortSettings service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetPortSettings Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates information about a registered game server to help GameLift FleetIQ to track - game server availability. This operation is called by a game server process that is - running on an instance in a game server group. - - - - Use this operation to update the following types of game server information. You can - make all three types of updates in the same request: - -
  • - - To update the game server's utilization status, identify the game server and game - server group and specify the current utilization status. Use this status to identify - when game servers are currently hosting games and when they are available to be claimed. - -
  • - - To report health status, identify the game server and game server group and set health - check to HEALTHY. If a game server does not report health status for - a certain length of time, the game server is no longer considered healthy. As a result, - it will be eventually deregistered from the game server group to avoid affecting utilization - metrics. The best practice is to report health every 60 seconds. - -
  • - - To change game server metadata, provide updated game server data. - -
- - Once a game server is successfully updated, the relevant statuses and timestamps are - updated. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServer service method. - - The response from the UpdateGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates information about a registered game server to help GameLift FleetIQ to track - game server availability. This operation is called by a game server process that is - running on an instance in a game server group. - - - - Use this operation to update the following types of game server information. You can - make all three types of updates in the same request: - -
  • - - To update the game server's utilization status, identify the game server and game - server group and specify the current utilization status. Use this status to identify - when game servers are currently hosting games and when they are available to be claimed. - -
  • - - To report health status, identify the game server and game server group and set health - check to HEALTHY. If a game server does not report health status for - a certain length of time, the game server is no longer considered healthy. As a result, - it will be eventually deregistered from the game server group to avoid affecting utilization - metrics. The best practice is to report health every 60 seconds. - -
  • - - To change game server metadata, provide updated game server data. - -
- - Once a game server is successfully updated, the relevant statuses and timestamps are - updated. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling - group properties are updated on the Auto Scaling group directly, including the launch - template, Auto Scaling policies, and maximum/minimum/desired instance counts. - - - - To update the game server group, specify the game server group ID and provide the - updated values. Before applying the updates, the new values are validated to ensure - that GameLift FleetIQ can continue to perform instance balancing activity. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServerGroup service method. - - The response from the UpdateGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling - group properties are updated on the Auto Scaling group directly, including the launch - template, Auto Scaling policies, and maximum/minimum/desired instance counts. - - - - To update the game server group, specify the game server group ID and provide the - updated values. Before applying the updates, the new values are validated to ensure - that GameLift FleetIQ can continue to perform instance balancing activity. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServerGroup Operation - - - - Updates the mutable properties of a game session. - - - - To update a game session, specify the game session ID and the values you want to change. - - - - - If successful, the updated GameSession object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSession service method. - - The response from the UpdateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSession Operation - - - - Updates the mutable properties of a game session. - - - - To update a game session, specify the game session ID and the values you want to change. - - - - - If successful, the updated GameSession object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSession Operation - - - - Updates the configuration of a game session queue, which determines how the queue - processes new game session requests. To update settings, specify the queue name to - be updated and provide the new settings. When updating destinations, provide a complete - list of destinations. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSessionQueue service method. - - The response from the UpdateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSessionQueue Operation - - - - Updates the configuration of a game session queue, which determines how the queue - processes new game session requests. To update settings, specify the queue name to - be updated and provide the new settings. When updating destinations, provide a complete - list of destinations. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSessionQueue Operation - - - - Updates settings for a FlexMatch matchmaking configuration. These changes affect all - matches and game sessions that are created after the update. To update settings, specify - the configuration name to be updated and provide the new settings. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the UpdateMatchmakingConfiguration service method. - - The response from the UpdateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for UpdateMatchmakingConfiguration Operation - - - - Updates settings for a FlexMatch matchmaking configuration. These changes affect all - matches and game sessions that are created after the update. To update settings, specify - the configuration name to be updated and provide the new settings. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the UpdateMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for UpdateMatchmakingConfiguration Operation - - - - Updates the current runtime configuration for the specified fleet, which tells GameLift - how to launch server processes on all instances in the fleet. You can update a fleet's - runtime configuration at any time after the fleet is created; it does not need to - be in ACTIVE status. - - - - To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration - with an updated set of server process configurations. - - - - If successful, the fleet's runtime configuration settings are updated. Each instance - in the fleet regularly checks for and retrieves updated runtime configurations. Instances - immediately begin complying with the new configuration by launching new server processes - or not replacing existing processes when they shut down. Updating a fleet's runtime - configuration never affects existing server processes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateRuntimeConfiguration service method. - - The response from the UpdateRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateRuntimeConfiguration Operation - - - - Updates the current runtime configuration for the specified fleet, which tells GameLift - how to launch server processes on all instances in the fleet. You can update a fleet's - runtime configuration at any time after the fleet is created; it does not need to - be in ACTIVE status. - - - - To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration - with an updated set of server process configurations. - - - - If successful, the fleet's runtime configuration settings are updated. Each instance - in the fleet regularly checks for and retrieves updated runtime configurations. Instances - immediately begin complying with the new configuration by launching new server processes - or not replacing existing processes when they shut down. Updating a fleet's runtime - configuration never affects existing server processes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateRuntimeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateRuntimeConfiguration Operation - - - - Updates Realtime script metadata and content. - - - - To update script metadata, specify the script ID and provide updated name and/or version - values. - - - - To update script content, provide an updated zip file by pointing to either a local - file or an Amazon S3 bucket location. You can use either method regardless of how - the original script was uploaded. Use the Version parameter to track updates - to the script. - - - - If the call is successful, the updated metadata is stored in the script record and - a revised script is uploaded to the Amazon GameLift service. Once the script is updated - and acquired by a fleet instance, the new version is used for all new game sessions. - - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the UpdateScript service method. - - The response from the UpdateScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateScript Operation - - - - Updates Realtime script metadata and content. - - - - To update script metadata, specify the script ID and provide updated name and/or version - values. - - - - To update script content, provide an updated zip file by pointing to either a local - file or an Amazon S3 bucket location. You can use either method regardless of how - the original script was uploaded. Use the Version parameter to track updates - to the script. - - - - If the call is successful, the updated metadata is stored in the script record and - a revised script is uploaded to the Amazon GameLift service. Once the script is updated - and acquired by a fleet instance, the new version is used for all new game sessions. - - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the UpdateScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateScript Operation - - - - Validates the syntax of a matchmaking rule or rule set. This operation checks that - the rule set is using syntactically correct JSON and that it conforms to allowed property - expressions. To validate syntax, provide a rule set JSON string. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the ValidateMatchmakingRuleSet service method. - - The response from the ValidateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for ValidateMatchmakingRuleSet Operation - - - - Validates the syntax of a matchmaking rule or rule set. This operation checks that - the rule set is using syntactically correct JSON and that it conforms to allowed property - expressions. To validate syntax, provide a rule set JSON string. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the ValidateMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for ValidateMatchmakingRuleSet Operation - - - - Interface for accessing GameLift - - Amazon GameLift Service - - GameLift provides solutions for hosting session-based multiplayer game servers in - the cloud, including tools for deploying, operating, and scaling game servers. Built - on AWS global computing infrastructure, GameLift helps you deliver high-performance, - high-reliability, low-cost game servers while dynamically scaling your resource usage - to meet player demand. - - - - About GameLift solutions - - - - Get more information on these GameLift solutions in the GameLift - Developer Guide. - -
  • - - GameLift managed hosting -- GameLift offers a fully managed service to set up and - maintain computing machines for hosting, manage game session and player session life - cycle, and handle security, storage, and performance tracking. You can use automatic - scaling tools to balance player demand and hosting costs, configure your game session - management to minimize player latency, and add FlexMatch for matchmaking. - -
  • - - Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly - configure and set up ready-to-go game servers for your game. Realtime Servers provides - a game server framework with core GameLift infrastructure already built in. Then use - the full range of GameLift managed hosting features, including FlexMatch, for your - game. - -
  • - - GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your - games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations - for game hosting, including boosting the viability of low-cost Spot Instances gaming. - For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services. - -
  • - - GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is - a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated - with GameLift managed hosting or incorporate FlexMatch as a standalone service into - your own hosting solution. - -
- - About this API Reference - - - - This reference guide describes the low-level service API for Amazon GameLift. With - each topic in this guide, you can find links to language-specific SDK guides and the - AWS CLI reference. Useful links: - - - - - - - Paginators for the service - - - - - Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking - configuration may require player acceptance; if so, then matches built with that configuration - cannot be completed unless all players accept the proposed match within a specified - time limit. - - - - When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - your game to get acceptance from all players in the ticket. Acceptances are only valid - for tickets when they are in this status; all other acceptances result in an error. - - - - To register acceptance, specify the ticket ID, a response, and one or more players. - Once all players have registered acceptance, the matchmaking tickets advance to status - PLACING, where a new game session is created for the match. - - - - If any player rejects the match, or if acceptances are not received before a specified - timeout, the proposed match is dropped. The matchmaking tickets are then handled in - one of two ways: For tickets where one or more players rejected the match, the ticket - status is returned to SEARCHING to find a new match. For tickets where - one or more players failed to respond, the ticket status is set to CANCELLED, - and processing is terminated. A new matchmaking request for these players can be submitted - as needed. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - FlexMatch events (reference) - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the AcceptMatch service method. - - The response from the AcceptMatch service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for AcceptMatch Operation - - - - Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking - configuration may require player acceptance; if so, then matches built with that configuration - cannot be completed unless all players accept the proposed match within a specified - time limit. - - - - When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - your game to get acceptance from all players in the ticket. Acceptances are only valid - for tickets when they are in this status; all other acceptances result in an error. - - - - To register acceptance, specify the ticket ID, a response, and one or more players. - Once all players have registered acceptance, the matchmaking tickets advance to status - PLACING, where a new game session is created for the match. - - - - If any player rejects the match, or if acceptances are not received before a specified - timeout, the proposed match is dropped. The matchmaking tickets are then handled in - one of two ways: For tickets where one or more players rejected the match, the ticket - status is returned to SEARCHING to find a new match. For tickets where - one or more players failed to respond, the ticket status is set to CANCELLED, - and processing is terminated. A new matchmaking request for these players can be submitted - as needed. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - FlexMatch events (reference) - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the AcceptMatch service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AcceptMatch service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for AcceptMatch Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Locates an available game server and temporarily reserves it to host gameplay and - players. This operation is called from a game client or client service (such as a - matchmaker) to request hosting resources for a new game session. In response, GameLift - FleetIQ locates an available game server, places it in CLAIMED status - for 60 seconds, and returns connection information that players can use to connect - to the game server. - - - - To claim a game server, identify a game server group. You can also specify a game - server ID, although this approach bypasses GameLift FleetIQ placement optimization. - Optionally, include game data to pass to the game server at the start of a game session, - such as a game map or player information. - - - - When a game server is successfully claimed, connection information is returned. A - claimed game server's utilization status remains AVAILABLE while the - claim status is set to CLAIMED for up to 60 seconds. This time period - gives the game server time to update its status to UTILIZED (using UpdateGameServer) - once players join. If the game server's status is not updated within 60 seconds, the - game server reverts to unclaimed status and is available to be claimed by another - request. The claim time period is a fixed value and is not configurable. - - - - If you try to claim a specific game server, this request will fail in the following - cases: - -
  • - - If the game server utilization status is UTILIZED. - -
  • - - If the game server claim status is CLAIMED. - -
- - When claiming a specific game server, this request will succeed even if the game server - is running on an instance in DRAINING status. To avoid this, first check - the instance status by calling DescribeGameServerInstances. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ClaimGameServer service method. - - The response from the ClaimGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The specified game server group has no available game servers to fulfill a ClaimGameServer - request. Clients can retry such requests immediately or after a waiting period. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ClaimGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Locates an available game server and temporarily reserves it to host gameplay and - players. This operation is called from a game client or client service (such as a - matchmaker) to request hosting resources for a new game session. In response, GameLift - FleetIQ locates an available game server, places it in CLAIMED status - for 60 seconds, and returns connection information that players can use to connect - to the game server. - - - - To claim a game server, identify a game server group. You can also specify a game - server ID, although this approach bypasses GameLift FleetIQ placement optimization. - Optionally, include game data to pass to the game server at the start of a game session, - such as a game map or player information. - - - - When a game server is successfully claimed, connection information is returned. A - claimed game server's utilization status remains AVAILABLE while the - claim status is set to CLAIMED for up to 60 seconds. This time period - gives the game server time to update its status to UTILIZED (using UpdateGameServer) - once players join. If the game server's status is not updated within 60 seconds, the - game server reverts to unclaimed status and is available to be claimed by another - request. The claim time period is a fixed value and is not configurable. - - - - If you try to claim a specific game server, this request will fail in the following - cases: - -
  • - - If the game server utilization status is UTILIZED. - -
  • - - If the game server claim status is CLAIMED. - -
- - When claiming a specific game server, this request will succeed even if the game server - is running on an instance in DRAINING status. To avoid this, first check - the instance status by calling DescribeGameServerInstances. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ClaimGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ClaimGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The specified game server group has no available game servers to fulfill a ClaimGameServer - request. Clients can retry such requests immediately or after a waiting period. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ClaimGameServer Operation - - - - Creates an alias for a fleet. In most situations, you can use an alias ID in place - of a fleet ID. An alias provides a level of abstraction for a fleet that is useful - when redirecting player traffic from one fleet to another, such as when updating your - game build. - - - - Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. - A simple alias points to an active fleet. A terminal alias is used to display messaging - or link to a URL instead of routing players to an active fleet. For example, you might - use a terminal alias when a game version is no longer supported and you want to direct - players to an upgrade site. - - - - To create a fleet alias, specify an alias name, routing strategy, and optional description. - Each simple alias can point to only one fleet, but a fleet can have multiple aliases. - If successful, a new alias record is returned, including an alias ID and an ARN. You - can reassign an alias to another fleet by calling UpdateAlias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the CreateAlias service method. - - The response from the CreateAlias service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateAlias Operation - - - - Creates an alias for a fleet. In most situations, you can use an alias ID in place - of a fleet ID. An alias provides a level of abstraction for a fleet that is useful - when redirecting player traffic from one fleet to another, such as when updating your - game build. - - - - Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. - A simple alias points to an active fleet. A terminal alias is used to display messaging - or link to a URL instead of routing players to an active fleet. For example, you might - use a terminal alias when a game version is no longer supported and you want to direct - players to an upgrade site. - - - - To create a fleet alias, specify an alias name, routing strategy, and optional description. - Each simple alias can point to only one fleet, but a fleet can have multiple aliases. - If successful, a new alias record is returned, including an alias ID and an ARN. You - can reassign an alias to another fleet by calling UpdateAlias. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the CreateAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateAlias service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateAlias Operation - - - - Creates a new Amazon GameLift build resource for your game server binary files. Game - server binaries must be combined into a zip file for use with Amazon GameLift. - - - - When setting up a new game build for GameLift, we recommend using the AWS CLI command - upload-build - . This helper command combines two tasks: (1) it uploads your build files from - a file directory to a GameLift Amazon S3 location, and (2) it creates a new build - resource. - - - - The CreateBuild operation can used in the following scenarios: - -
  • - - To create a new game build with build files that are in an Amazon S3 location under - an AWS account that you control. To use this option, you must first give Amazon GameLift - access to the Amazon S3 bucket. With permissions in place, call CreateBuild - and specify a build name, operating system, and the Amazon S3 storage location of - your game build. - -
  • - - To directly upload your build files to a GameLift Amazon S3 location. To use this - option, first call CreateBuild and specify a build name and operating - system. This operation creates a new build resource and also returns an Amazon S3 - location with temporary access credentials. Use the credentials to manually upload - your build files to the specified Amazon S3 location. For more information, see Uploading - Objects in the Amazon S3 Developer Guide. Build files can be uploaded to - the GameLift Amazon S3 location once only; that can't be updated. - -
- - If successful, this operation creates a new build resource with a unique build ID - and places it in INITIALIZED status. A build must be in READY - status before you can create fleets with it. - - - - Learn more - - - - Uploading - Your Game - - - - - Create a Build with Files in Amazon S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the CreateBuild service method. - - The response from the CreateBuild service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateBuild Operation - - - - Creates a new Amazon GameLift build resource for your game server binary files. Game - server binaries must be combined into a zip file for use with Amazon GameLift. - - - - When setting up a new game build for GameLift, we recommend using the AWS CLI command - upload-build - . This helper command combines two tasks: (1) it uploads your build files from - a file directory to a GameLift Amazon S3 location, and (2) it creates a new build - resource. - - - - The CreateBuild operation can used in the following scenarios: - -
  • - - To create a new game build with build files that are in an Amazon S3 location under - an AWS account that you control. To use this option, you must first give Amazon GameLift - access to the Amazon S3 bucket. With permissions in place, call CreateBuild - and specify a build name, operating system, and the Amazon S3 storage location of - your game build. - -
  • - - To directly upload your build files to a GameLift Amazon S3 location. To use this - option, first call CreateBuild and specify a build name and operating - system. This operation creates a new build resource and also returns an Amazon S3 - location with temporary access credentials. Use the credentials to manually upload - your build files to the specified Amazon S3 location. For more information, see Uploading - Objects in the Amazon S3 Developer Guide. Build files can be uploaded to - the GameLift Amazon S3 location once only; that can't be updated. - -
- - If successful, this operation creates a new build resource with a unique build ID - and places it in INITIALIZED status. A build must be in READY - status before you can create fleets with it. - - - - Learn more - - - - Uploading - Your Game - - - - - Create a Build with Files in Amazon S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the CreateBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateBuild service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateBuild Operation - - - - Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your - custom game server or Realtime Servers. Use this operation to configure the computing - resources for your fleet and provide instructions for running game servers on each - instance. - - - - Most GameLift fleets can deploy instances to multiple locations, including the home - Region (where the fleet is created) and an optional set of remote locations. Fleets - that are created in the following AWS Regions support multiple locations: us-east-1 - (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets - that are created in other GameLift Regions can deploy instances in the fleet's home - Region only. All fleet instances use the same configuration regardless of location; - however, you can adjust capacity settings and turn auto-scaling on/off for each location. - - - - To create a fleet, choose the hardware for your instances, specify a game server build - or Realtime script to deploy, and provide a runtime configuration to direct GameLift - how to start and run game servers on each instance in the fleet. Set permissions for - inbound traffic to your game servers, and enable optional features as needed. When - creating a multi-location fleet, provide a list of additional remote locations. - - - - If successful, this operation creates a new Fleet resource and places it in NEW - status, which prompts GameLift to initiate the fleet - creation workflow. You can track fleet creation by checking fleet status using - DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by - monitoring fleet creation events using DescribeFleetEvents. As soon as the - fleet status changes to ACTIVE, you can enable automatic scaling for - the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. - When the status of each remote location reaches ACTIVE, you can set capacity - by location using UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Debug - fleet creation issues - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleet service method. - - The response from the CreateFleet service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleet Operation - - - - Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your - custom game server or Realtime Servers. Use this operation to configure the computing - resources for your fleet and provide instructions for running game servers on each - instance. - - - - Most GameLift fleets can deploy instances to multiple locations, including the home - Region (where the fleet is created) and an optional set of remote locations. Fleets - that are created in the following AWS Regions support multiple locations: us-east-1 - (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets - that are created in other GameLift Regions can deploy instances in the fleet's home - Region only. All fleet instances use the same configuration regardless of location; - however, you can adjust capacity settings and turn auto-scaling on/off for each location. - - - - To create a fleet, choose the hardware for your instances, specify a game server build - or Realtime script to deploy, and provide a runtime configuration to direct GameLift - how to start and run game servers on each instance in the fleet. Set permissions for - inbound traffic to your game servers, and enable optional features as needed. When - creating a multi-location fleet, provide a list of additional remote locations. - - - - If successful, this operation creates a new Fleet resource and places it in NEW - status, which prompts GameLift to initiate the fleet - creation workflow. You can track fleet creation by checking fleet status using - DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by - monitoring fleet creation events using DescribeFleetEvents. As soon as the - fleet status changes to ACTIVE, you can enable automatic scaling for - the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. - When the status of each remote location reaches ACTIVE, you can set capacity - by location using UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Debug - fleet creation issues - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateFleet service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleet Operation - - - - Adds remote locations to a fleet and begins populating the new locations with EC2 - instances. The new instances conform to the fleet's instance type, auto-scaling, and - other configuration settings. - - - - This operation cannot be used with fleets that don't support remote locations. Fleets - can have multiple locations only if they reside in AWS Regions that support this feature - (see CreateFleet for the complete list) and were created after the feature - was released in March 2021. - - - - To add fleet locations, specify the fleet to be updated and provide a list of one - or more locations. - - - - If successful, this operation returns the list of added locations with their status - set to NEW. GameLift initiates the process of starting an instance in - each added location. You can track the status of each new location by monitoring location - creation events using DescribeFleetEvents. Alternatively, you can poll location - status by calling DescribeFleetLocationAttributes. After a location status - becomes ACTIVE, you can adjust the location's capacity as needed with - UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleetLocations service method. - - The response from the CreateFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleetLocations Operation - - - - Adds remote locations to a fleet and begins populating the new locations with EC2 - instances. The new instances conform to the fleet's instance type, auto-scaling, and - other configuration settings. - - - - This operation cannot be used with fleets that don't support remote locations. Fleets - can have multiple locations only if they reside in AWS Regions that support this feature - (see CreateFleet for the complete list) and were created after the feature - was released in March 2021. - - - - To add fleet locations, specify the fleet to be updated and provide a list of one - or more locations. - - - - If successful, this operation returns the list of added locations with their status - set to NEW. GameLift initiates the process of starting an instance in - each added location. You can track the status of each new location by monitoring location - creation events using DescribeFleetEvents. Alternatively, you can poll location - status by calling DescribeFleetLocationAttributes. After a location status - becomes ACTIVE, you can adjust the location's capacity as needed with - UpdateFleetCapacity. - - - - Learn more - - - - Setting - up fleets - - - - Multi-location - fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the CreateFleetLocations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateFleetLocations Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a GameLift FleetIQ game server group for managing game hosting on a collection - of Amazon EC2 instances for game hosting. This operation creates the game server group, - creates an Auto Scaling group in your AWS account, and establishes a link between - the two groups. You can view the status of your game server groups in the GameLift - console. Game server group metrics and events are emitted to Amazon CloudWatch. - - - - Before creating a new game server group, you must have the following: - -
  • - - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with - your game server build. For more information, see - Launching an Instance from a Launch Template in the Amazon EC2 User Guide. - - -
  • - - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ - to create and interact with the Auto Scaling group. For more information, see Create - IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. - -
- - To create a new game server group, specify a unique group name, IAM role and Amazon - EC2 launch template, and provide a list of instance types that can be used in the - group. You must also set initial maximum and minimum limits on the group's instance - count. You can optionally set an Auto Scaling policy with target tracking based on - a GameLift FleetIQ metric. - - - - Once the game server group and corresponding Auto Scaling group are created, you have - full access to change the Auto Scaling group's configuration as needed. Several properties - that are set when creating a game server group, including maximum/minimum size and - auto-scaling policy settings, must be updated directly in the Auto Scaling group. - Keep in mind that some Auto Scaling group properties are periodically updated by GameLift - FleetIQ as part of its balancing activities to optimize for availability and cost. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameServerGroup service method. - - The response from the CreateGameServerGroup service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a GameLift FleetIQ game server group for managing game hosting on a collection - of Amazon EC2 instances for game hosting. This operation creates the game server group, - creates an Auto Scaling group in your AWS account, and establishes a link between - the two groups. You can view the status of your game server groups in the GameLift - console. Game server group metrics and events are emitted to Amazon CloudWatch. - - - - Before creating a new game server group, you must have the following: - -
  • - - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with - your game server build. For more information, see - Launching an Instance from a Launch Template in the Amazon EC2 User Guide. - - -
  • - - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ - to create and interact with the Auto Scaling group. For more information, see Create - IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. - -
- - To create a new game server group, specify a unique group name, IAM role and Amazon - EC2 launch template, and provide a list of instance types that can be used in the - group. You must also set initial maximum and minimum limits on the group's instance - count. You can optionally set an Auto Scaling policy with target tracking based on - a GameLift FleetIQ metric. - - - - Once the game server group and corresponding Auto Scaling group are created, you have - full access to change the Auto Scaling group's configuration as needed. Several properties - that are set when creating a game server group, including maximum/minimum size and - auto-scaling policy settings, must be updated directly in the Auto Scaling group. - Keep in mind that some Auto Scaling group properties are periodically updated by GameLift - FleetIQ as part of its balancing activities to optimize for availability and cost. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameServerGroup service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameServerGroup Operation - - - - Creates a multiplayer game session for players in a specific fleet location. This - operation prompts an available server process to start a game session and retrieves - connection information for the new game session. As an alternative, consider using - the GameLift game session placement feature with - - - - with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to - optimize the placement process. - - - - When creating a game session, you specify exactly where you want to place it and provide - a set of game session configuration settings. The fleet must be in ACTIVE - status before a game session can be created in it. - - - - This operation can be used in the following ways: - -
  • - - To create a game session on an instance in a fleet's home Region, provide a fleet - or alias ID along with your game session configuration. - -
  • - - To create a game session on an instance in a fleet's remote location, provide a fleet - or alias ID and a location name, along with your game session configuration. - -
- - If successful, a workflow is initiated to start a new game session. A GameSession - object is returned containing the game session configuration and status. When the - status is ACTIVE, game session connection information is provided and - player sessions can be created for the game session. By default, newly created game - sessions are open to new players. You can restrict new player access by using UpdateGameSession - to change the game session's player session creation policy. - - - - Game session logs are retained for all active game sessions for 14 days. To access - the logs, call GetGameSessionLogUrl to download the log files. - - - - Available in GameLift Local. - - - - Learn more - - - - Start - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSession service method. - - The response from the CreateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The specified fleet has no available instances to fulfill a CreateGameSession - request. Clients can retry such requests immediately or after a waiting period. - - - A game session with this custom ID string already exists in this fleet. Resolve this - conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSession Operation - - - - Creates a multiplayer game session for players in a specific fleet location. This - operation prompts an available server process to start a game session and retrieves - connection information for the new game session. As an alternative, consider using - the GameLift game session placement feature with - - - - with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to - optimize the placement process. - - - - When creating a game session, you specify exactly where you want to place it and provide - a set of game session configuration settings. The fleet must be in ACTIVE - status before a game session can be created in it. - - - - This operation can be used in the following ways: - -
  • - - To create a game session on an instance in a fleet's home Region, provide a fleet - or alias ID along with your game session configuration. - -
  • - - To create a game session on an instance in a fleet's remote location, provide a fleet - or alias ID and a location name, along with your game session configuration. - -
- - If successful, a workflow is initiated to start a new game session. A GameSession - object is returned containing the game session configuration and status. When the - status is ACTIVE, game session connection information is provided and - player sessions can be created for the game session. By default, newly created game - sessions are open to new players. You can restrict new player access by using UpdateGameSession - to change the game session's player session creation policy. - - - - Game session logs are retained for all active game sessions for 14 days. To access - the logs, call GetGameSessionLogUrl to download the log files. - - - - Available in GameLift Local. - - - - Learn more - - - - Start - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The specified fleet has no available instances to fulfill a CreateGameSession - request. Clients can retry such requests immediately or after a waiting period. - - - A game session with this custom ID string already exists in this fleet. Resolve this - conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSession Operation - - - - Creates a placement queue that processes requests for new game sessions. A queue uses - FleetIQ algorithms to determine the best placement locations and find an available - game server there, then prompts the game server process to start a new game session. - - - - - A game session queue is configured with a set of destinations (GameLift fleets or - aliases), which determine the locations where the queue can place new game sessions. - These destinations can span multiple fleet types (Spot and On-Demand), instance types, - and AWS Regions. If the queue includes multi-location fleets, the queue is able to - place game sessions in all of a fleet's remote locations. You can opt to filter out - individual locations if needed. - - - - The queue configuration also determines how FleetIQ selects the best available placement - for a new game session. Before searching for an available game server, FleetIQ first - prioritizes the queue's destinations and locations, with the best placement locations - on top. You can set up the queue to use the FleetIQ default prioritization or provide - an alternate set of priorities. - - - - To create a new queue, provide a name, timeout value, and a list of destinations. - Optionally, specify a sort configuration and/or a filter, and define a set of latency - cap policies. You can also include the ARN for an Amazon Simple Notification Service - (SNS) topic to receive notifications of game session placement activity. Notifications - using SNS or CloudWatch events is the preferred way to track placement activity. - - - - If successful, a new GameSessionQueue object is returned with an assigned - queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement - or StartMatchmaking, reference a queue's name or ARN. - - - - Learn more - - - - - Design a game session queue - - - - - Create a game session queue - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSessionQueue service method. - - The response from the CreateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSessionQueue Operation - - - - Creates a placement queue that processes requests for new game sessions. A queue uses - FleetIQ algorithms to determine the best placement locations and find an available - game server there, then prompts the game server process to start a new game session. - - - - - A game session queue is configured with a set of destinations (GameLift fleets or - aliases), which determine the locations where the queue can place new game sessions. - These destinations can span multiple fleet types (Spot and On-Demand), instance types, - and AWS Regions. If the queue includes multi-location fleets, the queue is able to - place game sessions in all of a fleet's remote locations. You can opt to filter out - individual locations if needed. - - - - The queue configuration also determines how FleetIQ selects the best available placement - for a new game session. Before searching for an available game server, FleetIQ first - prioritizes the queue's destinations and locations, with the best placement locations - on top. You can set up the queue to use the FleetIQ default prioritization or provide - an alternate set of priorities. - - - - To create a new queue, provide a name, timeout value, and a list of destinations. - Optionally, specify a sort configuration and/or a filter, and define a set of latency - cap policies. You can also include the ARN for an Amazon Simple Notification Service - (SNS) topic to receive notifications of game session placement activity. Notifications - using SNS or CloudWatch events is the preferred way to track placement activity. - - - - If successful, a new GameSessionQueue object is returned with an assigned - queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement - or StartMatchmaking, reference a queue's name or ARN. - - - - Learn more - - - - - Design a game session queue - - - - - Create a game session queue - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the CreateGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateGameSessionQueue Operation - - - - Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - configuration sets out rules for matching players and forming teams. If you're also - using GameLift hosting, it defines how to start game sessions for each match. Your - matchmaking system can use multiple configurations to handle different game scenarios. - All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify - the matchmaking configuration to use and provide player attributes consistent with - that configuration. - - - - To create a matchmaking configuration, you must provide the following: configuration - name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies - how to evaluate players and find acceptable matches; whether player acceptance is - required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch - with GameLift hosting, you also need to identify the game session queue to use when - starting a game session for the match. - - - - In addition, you must set up an Amazon Simple Notification Service (SNS) topic to - receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. - An alternative method, continuously polling ticket status with DescribeMatchmaking, - is only suitable for games in development with low matchmaking usage. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - - Set up FlexMatch event notification - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingConfiguration service method. - - The response from the CreateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingConfiguration Operation - - - - Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - configuration sets out rules for matching players and forming teams. If you're also - using GameLift hosting, it defines how to start game sessions for each match. Your - matchmaking system can use multiple configurations to handle different game scenarios. - All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify - the matchmaking configuration to use and provide player attributes consistent with - that configuration. - - - - To create a matchmaking configuration, you must provide the following: configuration - name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies - how to evaluate players and find acceptable matches; whether player acceptance is - required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch - with GameLift hosting, you also need to identify the game session queue to use when - starting a game session for the match. - - - - In addition, you must set up an Amazon Simple Notification Service (SNS) topic to - receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. - An alternative method, continuously polling ticket status with DescribeMatchmaking, - is only suitable for games in development with low matchmaking usage. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - - Set up FlexMatch event notification - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingConfiguration Operation - - - - Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of - match to create, such as the number and size of teams. It also sets the parameters - for acceptable player matches, such as minimum skill level or character type. A rule - set is used by a MatchmakingConfiguration. - - - - To create a matchmaking rule set, provide unique rule set name and the rule set body - in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration - they are used with. - - - - Since matchmaking rule sets cannot be edited, it is a good idea to check the rule - set syntax using ValidateMatchmakingRuleSet before creating a new rule set. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingRuleSet service method. - - The response from the CreateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingRuleSet Operation - - - - Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of - match to create, such as the number and size of teams. It also sets the parameters - for acceptable player matches, such as minimum skill level or character type. A rule - set is used by a MatchmakingConfiguration. - - - - To create a matchmaking rule set, provide unique rule set name and the rule set body - in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration - they are used with. - - - - Since matchmaking rule sets cannot be edited, it is a good idea to check the rule - set syntax using ValidateMatchmakingRuleSet before creating a new rule set. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the CreateMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for CreateMatchmakingRuleSet Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add a player to. - A unique identifier for a player. Player IDs are developer-defined. - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSession service method. - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add a player to. - A unique identifier for a player. Player IDs are developer-defined. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves an open player slot in a game session for a player. New player sessions can - be created in any game session with an open slot that is in ACTIVE status - and has a player creation policy of ACCEPT_ALL. You can add a group of - players to a game session with CreatePlayerSessions. - - - - To create a player session, specify a game session ID, player ID, and optionally a - set of player data. - - - - If successful, a slot is reserved in the game session for the player and a new PlayerSession - object is returned with a player session ID. The player references the player session - ID when sending a connection request to the game session, and the game server can - use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSession service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSession Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add players to. - List of unique identifiers for the players to be added. - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSessions service method. - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - A unique identifier for the game session to add players to. - List of unique identifiers for the players to be added. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Reserves open slots in a game session for a group of players. New player sessions - can be created in any game session with an open slot that is in ACTIVE - status and has a player creation policy of ACCEPT_ALL. To add a single - player to a game session, use CreatePlayerSession. - - - - To create player sessions, specify a game session ID and a list of player IDs. Optionally, - provide a set of player data for each player ID. - - - - If successful, a slot is reserved in the game session for each player, and new PlayerSession - objects are returned with player session IDs. Each player references their player - session ID when sending a connection request to the game session, and the game server - can use it to validate the player reservation with the GameLift service. Player sessions - cannot be updated. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the CreatePlayerSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreatePlayerSessions service method, as returned by GameLift. - - The game instance is currently full and cannot allow the requested player(s) to join. - Clients can retry such requests immediately or after a waiting period. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreatePlayerSessions Operation - - - - Creates a new script record for your Realtime Servers script. Realtime scripts are - JavaScript that provide configuration settings and optional custom game logic for - your game. The script is deployed when you create a Realtime Servers fleet to host - your game sessions. Script logic is executed during an active game session. - - - - To create a new script record, specify a script name and provide the script file(s). - The script files and all dependencies must be zipped into a single file. You can pull - the zip file from either of these locations: - -
  • - - A locally available directory. Use the ZipFile parameter for this option. - -
  • - - An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the - StorageLocation parameter for this option. You'll need to have an Identity - Access Management (IAM) role that allows the Amazon GameLift service to access your - S3 bucket. - -
- - If the call is successful, a new script record is created with a unique script ID. - If the script file is provided as a local file, the file is uploaded to an Amazon - GameLift-owned S3 bucket and the script record's storage location reflects this location. - If the script file is provided as an S3 bucket, Amazon GameLift accesses the file - at this storage location as needed for deployment. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Set - Up a Role for Amazon GameLift Access - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the CreateScript service method. - - The response from the CreateScript service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateScript Operation - - - - Creates a new script record for your Realtime Servers script. Realtime scripts are - JavaScript that provide configuration settings and optional custom game logic for - your game. The script is deployed when you create a Realtime Servers fleet to host - your game sessions. Script logic is executed during an active game session. - - - - To create a new script record, specify a script name and provide the script file(s). - The script files and all dependencies must be zipped into a single file. You can pull - the zip file from either of these locations: - -
  • - - A locally available directory. Use the ZipFile parameter for this option. - -
  • - - An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the - StorageLocation parameter for this option. You'll need to have an Identity - Access Management (IAM) role that allows the Amazon GameLift service to access your - S3 bucket. - -
- - If the call is successful, a new script record is created with a unique script ID. - If the script file is provided as a local file, the file is uploaded to an Amazon - GameLift-owned S3 bucket and the script record's storage location reflects this location. - If the script file is provided as an S3 bucket, Amazon GameLift accesses the file - at this storage location as needed for deployment. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Set - Up a Role for Amazon GameLift Access - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the CreateScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateScript service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateScript Operation - - - - Requests authorization to create or delete a peer connection between the VPC for your - Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering - enables the game servers on your fleet to communicate directly with other AWS resources. - Once you've received authorization, call CreateVpcPeeringConnection to establish - the peering connection. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - You can peer with VPCs that are owned by any AWS account you have access to, including - the account that you use to manage your Amazon GameLift fleets. You cannot peer with - VPCs that are in different Regions. - - - - To request authorization to create a connection, call this operation from the AWS - account with the VPC that you want to peer to your Amazon GameLift fleet. For example, - to enable your game servers to retrieve data from a DynamoDB table, use the account - that manages that DynamoDB resource. Identify the following values: (1) The ID of - the VPC that you want to peer with, and (2) the ID of the AWS account that you use - to manage Amazon GameLift. If successful, VPC peering is authorized for the specified - VPC. - - - - To request authorization to delete a connection, call this operation from the AWS - account with the VPC that is peered with your Amazon GameLift fleet. Identify the - following values: (1) VPC ID that you want to delete the peering connection for, and - (2) ID of the AWS account that you use to manage Amazon GameLift. - - - - The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. - You must create or delete the peering connection while the authorization is valid. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringAuthorization service method. - - The response from the CreateVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringAuthorization Operation - - - - Requests authorization to create or delete a peer connection between the VPC for your - Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering - enables the game servers on your fleet to communicate directly with other AWS resources. - Once you've received authorization, call CreateVpcPeeringConnection to establish - the peering connection. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - You can peer with VPCs that are owned by any AWS account you have access to, including - the account that you use to manage your Amazon GameLift fleets. You cannot peer with - VPCs that are in different Regions. - - - - To request authorization to create a connection, call this operation from the AWS - account with the VPC that you want to peer to your Amazon GameLift fleet. For example, - to enable your game servers to retrieve data from a DynamoDB table, use the account - that manages that DynamoDB resource. Identify the following values: (1) The ID of - the VPC that you want to peer with, and (2) the ID of the AWS account that you use - to manage Amazon GameLift. If successful, VPC peering is authorized for the specified - VPC. - - - - To request authorization to delete a connection, call this operation from the AWS - account with the VPC that is peered with your Amazon GameLift fleet. Identify the - following values: (1) VPC ID that you want to delete the peering connection for, and - (2) ID of the AWS account that you use to manage Amazon GameLift. - - - - The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. - You must create or delete the peering connection while the authorization is valid. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringAuthorization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringAuthorization Operation - - - - Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS - account with the VPC for your Amazon GameLift fleet. VPC peering enables the game - servers on your fleet to communicate directly with other AWS resources. You can peer - with VPCs in any AWS account that you have access to, including the account that you - use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different - Regions. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - Before calling this operation to establish the peering connection, you first need - to call CreateVpcPeeringAuthorization and identify the VPC you want to peer - with. Once the authorization for the specified VPC is issued, you have 24 hours to - establish the connection. These two operations handle all tasks necessary to peer - the two VPCs, including acceptance, updating routing tables, etc. - - - - To establish the connection, call this operation from the AWS account that is used - to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of - the fleet you want to be enable a VPC peering connection for; (2) The AWS account - with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer - with. This operation is asynchronous. If successful, a VpcPeeringConnection - request is created. You can use continuous polling to track the request's status using - DescribeVpcPeeringConnections, or by monitoring fleet events for success or - failure using DescribeFleetEvents. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringConnection service method. - - The response from the CreateVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringConnection Operation - - - - Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS - account with the VPC for your Amazon GameLift fleet. VPC peering enables the game - servers on your fleet to communicate directly with other AWS resources. You can peer - with VPCs in any AWS account that you have access to, including the account that you - use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different - Regions. For more information, see VPC - Peering with Amazon GameLift Fleets. - - - - Before calling this operation to establish the peering connection, you first need - to call CreateVpcPeeringAuthorization and identify the VPC you want to peer - with. Once the authorization for the specified VPC is issued, you have 24 hours to - establish the connection. These two operations handle all tasks necessary to peer - the two VPCs, including acceptance, updating routing tables, etc. - - - - To establish the connection, call this operation from the AWS account that is used - to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of - the fleet you want to be enable a VPC peering connection for; (2) The AWS account - with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer - with. This operation is asynchronous. If successful, a VpcPeeringConnection - request is created. You can use continuous polling to track the request's status using - DescribeVpcPeeringConnections, or by monitoring fleet events for success or - failure using DescribeFleetEvents. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the CreateVpcPeeringConnection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CreateVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for CreateVpcPeeringConnection Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value. - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DeleteAlias service method. - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes an alias. This operation removes all record of the alias. Game clients attempting - to access a server process using the deleted alias receive an error. To delete an - alias, specify the alias ID to be deleted. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DeleteAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteAlias Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to delete. You can use either the build ID or ARN value. - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DeleteBuild service method. - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to delete. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes a build. This operation permanently deletes the build resource and any uploaded - build files. Deleting a build does not affect the status of any active fleets using - the build, but you can no longer create new fleets with the deleted build. - - - - To delete a build, specify the build ID. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DeleteBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteBuild Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value. - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleet service method. - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Deletes all resources and information related a fleet. Any current fleet instances, - including those in remote locations, are shut down. You don't need to call DeleteFleetLocations - separately. - - - - If the fleet being deleted has a VPC peering connection, you first need to get a valid - authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. - You do not need to explicitly delete the VPC peering connection--this is done as part - of the delete fleet process. - - - - To delete a fleet, specify the fleet ID to be terminated. During the deletion process - the fleet status is changed to DELETING. When completed, the status switches - to TERMINATED and the fleet event FLEET_DELETED is sent. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleet Operation - - - - Removes locations from a multi-location fleet. When deleting a location, all game - server process and all instances that are still active in the location are shut down. - - - - - To delete fleet locations, identify the fleet ID and provide a list of the locations - to be deleted. - - - - If successful, GameLift sets the location status to DELETING, and begins - to shut down existing server processes and terminate instances in each location being - deleted. When completed, the location status changes to TERMINATED. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleetLocations service method. - - The response from the DeleteFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleetLocations Operation - - - - Removes locations from a multi-location fleet. When deleting a location, all game - server process and all instances that are still active in the location are shut down. - - - - - To delete fleet locations, identify the fleet ID and provide a list of the locations - to be deleted. - - - - If successful, GameLift sets the location status to DELETING, and begins - to shut down existing server processes and terminate instances in each location being - deleted. When completed, the location status changes to TERMINATED. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DeleteFleetLocations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteFleetLocations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteFleetLocations Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Terminates a game server group and permanently deletes the game server group record. - You have several options for how these resources are impacted when deleting the game - server group. Depending on the type of delete operation selected, this operation might - affect these resources: - -
  • - - The game server group - -
  • - - The corresponding Auto Scaling group - -
  • - - All game servers that are currently running in the group - -
- - To delete a game server group, identify the game server group to delete and specify - the type of delete operation to initiate. Game server groups can only be deleted if - they are in ACTIVE or ERROR status. - - - - If the delete request is successful, a series of operations are kicked off. The game - server group status is changed to DELETE_SCHEDULED, which prevents new - game servers from being registered and stops automatic scaling activity. Once all - game servers in the game server group are deregistered, GameLift FleetIQ can begin - deleting resources. If any of the delete operations fail, the game server group is - placed in ERROR status. - - - - GameLift FleetIQ emits delete events to Amazon CloudWatch. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameServerGroup service method. - - The response from the DeleteGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Terminates a game server group and permanently deletes the game server group record. - You have several options for how these resources are impacted when deleting the game - server group. Depending on the type of delete operation selected, this operation might - affect these resources: - -
  • - - The game server group - -
  • - - The corresponding Auto Scaling group - -
  • - - All game servers that are currently running in the group - -
- - To delete a game server group, identify the game server group to delete and specify - the type of delete operation to initiate. Game server groups can only be deleted if - they are in ACTIVE or ERROR status. - - - - If the delete request is successful, a series of operations are kicked off. The game - server group status is changed to DELETE_SCHEDULED, which prevents new - game servers from being registered and stops automatic scaling activity. Once all - game servers in the game server group are deregistered, GameLift FleetIQ can begin - deleting resources. If any of the delete operations fail, the game server group is - placed in ERROR status. - - - - GameLift FleetIQ emits delete events to Amazon CloudWatch. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameServerGroup Operation - - - - Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement - requests that reference the queue will fail. To delete a queue, specify the queue - name. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameSessionQueue service method. - - The response from the DeleteGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameSessionQueue Operation - - - - Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement - requests that reference the queue will fail. To delete a queue, specify the queue - name. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DeleteGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteGameSessionQueue Operation - - - - Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - configuration name. A matchmaking configuration cannot be deleted if it is being used - in any active matchmaking tickets. - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingConfiguration service method. - - The response from the DeleteMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingConfiguration Operation - - - - Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - configuration name. A matchmaking configuration cannot be deleted if it is being used - in any active matchmaking tickets. - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingConfiguration Operation - - - - Deletes an existing matchmaking rule set. To delete the rule set, provide the rule - set name. Rule sets cannot be deleted if they are currently being used by a matchmaking - configuration. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingRuleSet service method. - - The response from the DeleteMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingRuleSet Operation - - - - Deletes an existing matchmaking rule set. To delete the rule set, provide the rule - set name. Rule sets cannot be deleted if they are currently being used by a matchmaking - configuration. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DeleteMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DeleteMatchmakingRuleSet Operation - - - - Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - GameLift removes all record of it. To delete a scaling policy, specify both the scaling - policy name and the fleet ID it is associated with. - - - - To temporarily suspend scaling policies, call StopFleetActions. This operation - suspends all policies for the fleet. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScalingPolicy service method. - - The response from the DeleteScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScalingPolicy Operation - - - - Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - GameLift removes all record of it. To delete a scaling policy, specify both the scaling - policy name and the fleet ID it is associated with. - - - - To temporarily suspend scaling policies, call StopFleetActions. This operation - suspends all policies for the fleet. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScalingPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScalingPolicy Operation - - - - Deletes a Realtime script. This operation permanently deletes the script record. If - script files were uploaded, they are also deleted (files stored in an S3 bucket are - not deleted). - - - - To delete a script, specify the script ID. Before deleting a script, be sure to terminate - all fleets that are deployed with the script being deleted. Fleet instances periodically - check for script updates, and if the script record no longer exists, the instance - will go into an error state and be unable to host game sessions. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScript service method. - - The response from the DeleteScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScript Operation - - - - Deletes a Realtime script. This operation permanently deletes the script record. If - script files were uploaded, they are also deleted (files stored in an S3 bucket are - not deleted). - - - - To delete a script, specify the script ID. Before deleting a script, be sure to terminate - all fleets that are deployed with the script being deleted. Fleet instances periodically - check for script updates, and if the script record no longer exists, the instance - will go into an error state and be unable to host game sessions. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DeleteScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteScript Operation - - - - Cancels a pending VPC peering authorization for the specified VPC. If you need to - delete an existing VPC peering connection, call DeleteVpcPeeringConnection. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringAuthorization service method. - - The response from the DeleteVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringAuthorization Operation - - - - Cancels a pending VPC peering authorization for the specified VPC. If you need to - delete an existing VPC peering connection, call DeleteVpcPeeringConnection. - - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringAuthorization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteVpcPeeringAuthorization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringAuthorization Operation - - - - Removes a VPC peering connection. To delete the connection, you must have a valid - authorization for the VPC peering connection that you want to delete. You can check - for an authorization by calling DescribeVpcPeeringAuthorizations or request - a new one using CreateVpcPeeringAuthorization. - - - - Once a valid authorization exists, call this operation from the AWS account that is - used to manage the Amazon GameLift fleets. Identify the connection to delete by the - connection ID and fleet ID. If successful, the connection is removed. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method. - - The response from the DeleteVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringConnection Operation - - - - Removes a VPC peering connection. To delete the connection, you must have a valid - authorization for the VPC peering connection that you want to delete. You can check - for an authorization by calling DescribeVpcPeeringAuthorizations or request - a new one using CreateVpcPeeringAuthorization. - - - - Once a valid authorization exists, call this operation from the AWS account that is - used to manage the Amazon GameLift fleets. Identify the connection to delete by the - connection ID and fleet ID. If successful, the connection is removed. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteVpcPeeringConnection service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeleteVpcPeeringConnection Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Removes the game server from a game server group. As a result of this operation, the - deregistered game server can no longer be claimed and will not be returned in a list - of active game servers. - - - - To deregister a game server, specify the game server group and game server ID. If - successful, this operation emits a CloudWatch event with termination timestamp and - reason. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DeregisterGameServer service method. - - The response from the DeregisterGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeregisterGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Removes the game server from a game server group. As a result of this operation, the - deregistered game server can no longer be claimed and will not be returned in a list - of active game servers. - - - - To deregister a game server, specify the game server group and game server ID. If - successful, this operation emits a CloudWatch event with termination timestamp and - reason. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DeregisterGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeregisterGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DeregisterGameServer Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DescribeAlias service method. - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for an alias. This operation returns all alias metadata and settings. - To get an alias's target fleet ID only, use ResolveAlias. - - - - To get alias properties, specify the alias ID. If successful, the requested alias - record is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the DescribeAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeAlias Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DescribeBuild service method. - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - Retrieves properties for a custom game build. To request a build resource, specify - a build ID. If successful, an object containing the build properties is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the DescribeBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeBuild Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types. - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeEC2InstanceLimits service method. - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - The GameLift service limits and current utilization for an AWS Region or location. - Instance limits control the number of instances, per instance type, per location, - that your AWS account can use. Learn more at Amazon - EC2 Instance Types. The information returned includes the maximum number of instances - allowed and your account's current usage across all fleets. This information can affect - your ability to scale your GameLift fleets. You can request a limit increase for your - account by using the Service limits page in the GameLift console. - - - - Instance limits differ based on whether the instances are deployed in a fleet's home - Region or in a remote location. For remote locations, limits also differ based on - the combination of home Region and remote location. All requests must specify an AWS - Region (either explicitly or as your default settings). To get the limit for a remote - location, you must also specify the location. For example, the following requests - all return different results: - -
  • - - Request specifies the Region ap-northeast-1 with no location. The result - is limits and usage data on all instance types that are deployed in us-east-2, - by all of the fleets that reside in ap-northeast-1. - -
  • - - Request specifies the Region us-east-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in us-east-2. These limits do not affect - fleets in any other Regions that deploy instances to ca-central-1. - -
  • - - Request specifies the Region eu-west-1 with location ca-central-1. - The result is limits and usage data on all instance types that are deployed in ca-central-1, - by all of the fleets that reside in eu-west-1. - -
- - This operation can be used in the following ways: - -
  • - - To get limit and usage data for all instance types that are deployed in an AWS Region - by fleets that reside in the same Region: Specify the Region only. Optionally, specify - a single instance type to retrieve information for. - -
  • - - To get limit and usage data for all instance types that are deployed to a remote location - by fleets that reside in different AWS Region: Provide both the AWS Region and the - remote location. Optionally, specify a single instance type to retrieve information - for. - -
- - If successful, an EC2InstanceLimits object is returned with limits and - usage data for each requested instance type. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeEC2InstanceLimits service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeEC2InstanceLimits service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeEC2InstanceLimits Operation - - - - Retrieves core fleet-wide properties, including the computing hardware and deployment - configuration for all instances in the fleet. - - - - This operation can be used in the following ways: - -
  • - - To get attributes for one or more specific fleets, provide a list of fleet IDs or - fleet ARNs. - -
  • - - To get attributes for all fleets, do not provide a fleet identifier. - -
- - When requesting attributes for multiple fleets, use the pagination parameters to retrieve - results as a set of sequential pages. - - - - If successful, a FleetAttributes object is returned for each fleet requested, - unless the fleet identifier is not found. - - - - Some API operations limit the number of fleet IDs that allowed in one request. If - a request exceeds this limit, the request fails and the error message contains the - maximum allowed number. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetAttributes service method. - - The response from the DescribeFleetAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetAttributes Operation - - - - Retrieves core fleet-wide properties, including the computing hardware and deployment - configuration for all instances in the fleet. - - - - This operation can be used in the following ways: - -
  • - - To get attributes for one or more specific fleets, provide a list of fleet IDs or - fleet ARNs. - -
  • - - To get attributes for all fleets, do not provide a fleet identifier. - -
- - When requesting attributes for multiple fleets, use the pagination parameters to retrieve - results as a set of sequential pages. - - - - If successful, a FleetAttributes object is returned for each fleet requested, - unless the fleet identifier is not found. - - - - Some API operations limit the number of fleet IDs that allowed in one request. If - a request exceeds this limit, the request fails and the error message contains the - maximum allowed number. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetAttributes Operation - - - - Retrieves the resource capacity settings for one or more fleets. The data returned - includes the current fleet capacity (number of EC2 instances), and settings that can - control how capacity scaling. For fleets with remote locations, this operation retrieves - data for the fleet's home Region only. See DescribeFleetLocationCapacity to - get capacity settings for a fleet's remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get capacity data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get capacity data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetCapacity object is returned for each requested fleet - ID. Each FleetCapacity object includes a Location property, which is - set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - are returned only for fleets that currently exist. - - - - Some API operations may limit the number of fleet IDs that are allowed in one request. - If a request exceeds this limit, the request fails and the error message includes - the maximum allowed. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetCapacity service method. - - The response from the DescribeFleetCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetCapacity Operation - - - - Retrieves the resource capacity settings for one or more fleets. The data returned - includes the current fleet capacity (number of EC2 instances), and settings that can - control how capacity scaling. For fleets with remote locations, this operation retrieves - data for the fleet's home Region only. See DescribeFleetLocationCapacity to - get capacity settings for a fleet's remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get capacity data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get capacity data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetCapacity object is returned for each requested fleet - ID. Each FleetCapacity object includes a Location property, which is - set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - are returned only for fleets that currently exist. - - - - Some API operations may limit the number of fleet IDs that are allowed in one request. - If a request exceeds this limit, the request fails and the error message includes - the maximum allowed. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetCapacity Operation - - - - Retrieves entries from a fleet's event log. Fleet events are initiated by changes - in status, such as during fleet creation and termination, changes in capacity, etc. - If a fleet has multiple locations, events are also initiated by changes to status - and capacity in remote locations. - - - - You can specify a time range to limit the result set. Use the pagination parameters - to retrieve results as a set of sequential pages. - - - - If successful, a collection of event log entries matching the request are returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetEvents service method. - - The response from the DescribeFleetEvents service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetEvents Operation - - - - Retrieves entries from a fleet's event log. Fleet events are initiated by changes - in status, such as during fleet creation and termination, changes in capacity, etc. - If a fleet has multiple locations, events are also initiated by changes to status - and capacity in remote locations. - - - - You can specify a time range to limit the result set. Use the pagination parameters - to retrieve results as a set of sequential pages. - - - - If successful, a collection of event log entries matching the request are returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetEvents service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetEvents service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetEvents Operation - - - - Retrieves information on a fleet's remote locations, including life-cycle status and - any suspended fleet activity. - - - - This operation can be used in the following ways: - -
  • - - To get data for specific locations, provide a fleet identifier and a list of locations. - Location data is returned in the order that it is requested. - -
  • - - To get data for all locations, provide a fleet identifier only. Location data is returned - in no particular order. - -
- - When requesting attributes for multiple locations, use the pagination parameters to - retrieve results as a set of sequential pages. - - - - If successful, a LocationAttributes object is returned for each requested - location. If the fleet does not have a requested location, no information is returned. - This operation does not return the home Region. To get information on a fleet's home - Region, call DescribeFleetAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationAttributes service method. - - The response from the DescribeFleetLocationAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationAttributes Operation - - - - Retrieves information on a fleet's remote locations, including life-cycle status and - any suspended fleet activity. - - - - This operation can be used in the following ways: - -
  • - - To get data for specific locations, provide a fleet identifier and a list of locations. - Location data is returned in the order that it is requested. - -
  • - - To get data for all locations, provide a fleet identifier only. Location data is returned - in no particular order. - -
- - When requesting attributes for multiple locations, use the pagination parameters to - retrieve results as a set of sequential pages. - - - - If successful, a LocationAttributes object is returned for each requested - location. If the fleet does not have a requested location, no information is returned. - This operation does not return the home Region. To get information on a fleet's home - Region, call DescribeFleetAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationAttributes service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationAttributes Operation - - - - Retrieves the resource capacity settings for a fleet location. The data returned includes - the current capacity (number of EC2 instances) and some scaling settings for the requested - fleet location. Use this operation to retrieve capacity information for a fleet's - remote location or home Region (you can also retrieve home Region capacity by calling - DescribeFleetCapacity). - - - - To retrieve capacity data, identify a fleet and location. - - - - If successful, a FleetCapacity object is returned for the requested fleet - location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationCapacity service method. - - The response from the DescribeFleetLocationCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationCapacity Operation - - - - Retrieves the resource capacity settings for a fleet location. The data returned includes - the current capacity (number of EC2 instances) and some scaling settings for the requested - fleet location. Use this operation to retrieve capacity information for a fleet's - remote location or home Region (you can also retrieve home Region capacity by calling - DescribeFleetCapacity). - - - - To retrieve capacity data, identify a fleet and location. - - - - If successful, a FleetCapacity object is returned for the requested fleet - location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationCapacity service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationCapacity Operation - - - - Retrieves current usage data for a fleet location. Utilization data provides a snapshot - of current game hosting activity at the requested location. Use this operation to - retrieve utilization information for a fleet's remote location or home Region (you - can also retrieve home Region utilization by calling DescribeFleetUtilization). - - - - To retrieve utilization data, identify a fleet and location. - - - - If successful, a FleetUtilization object is returned for the requested - fleet location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationUtilization service method. - - The response from the DescribeFleetLocationUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationUtilization Operation - - - - Retrieves current usage data for a fleet location. Utilization data provides a snapshot - of current game hosting activity at the requested location. Use this operation to - retrieve utilization information for a fleet's remote location or home Region (you - can also retrieve home Region utilization by calling DescribeFleetUtilization). - - - - To retrieve utilization data, identify a fleet and location. - - - - If successful, a FleetUtilization object is returned for the requested - fleet location. - - - - Learn more - - - - Setting - up GameLift fleets - - - - GameLift - metrics for fleets - - - - Related actions - - - - CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity - | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity - | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions - | DeleteFleetLocations | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetLocationUtilization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetLocationUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetLocationUtilization Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value. - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetPortSettings service method. - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves a fleet's inbound connection permissions. Connection permissions specify - the range of IP addresses and port settings that incoming traffic can use to access - server processes in the fleet. Game sessions that are running on instances in the - fleet must use connections that fall in this range. - - - - This operation can be used in the following ways: - -
  • - - To retrieve the inbound connection permissions for a fleet, identify the fleet's unique - identifier. - -
  • - - To check the status of recent updates to a fleet remote location, specify the fleet - ID and a location. Port setting updates can take time to propagate across all locations. - - -
- - If successful, a set of IpPermission objects is returned for the requested - fleet ID. When a location is specified, a pending status is included. If the requested - fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetPortSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetPortSettings service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetPortSettings Operation - - - - Retrieves utilization statistics for one or more fleets. Utilization data provides - a snapshot of how the fleet's hosting resources are currently being used. For fleets - with remote locations, this operation retrieves data for the fleet's home Region only. - See DescribeFleetLocationUtilization to get utilization statistics for a fleet's - remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get utilization data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get utilization data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetUtilization object is returned for each requested fleet - ID, unless the fleet identifier is not found. Each fleet utilization object includes - a Location property, which is set to the fleet's home Region. - - - - Some API operations may limit the number of fleet IDs allowed in one request. If a - request exceeds this limit, the request fails and the error message includes the maximum - allowed. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - GameLift - Metrics for Fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetUtilization service method. - - The response from the DescribeFleetUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetUtilization Operation - - - - Retrieves utilization statistics for one or more fleets. Utilization data provides - a snapshot of how the fleet's hosting resources are currently being used. For fleets - with remote locations, this operation retrieves data for the fleet's home Region only. - See DescribeFleetLocationUtilization to get utilization statistics for a fleet's - remote locations. - - - - This operation can be used in the following ways: - -
  • - - To get utilization data for one or more specific fleets, provide a list of fleet IDs - or fleet ARNs. - -
  • - - To get utilization data for all fleets, do not provide a fleet identifier. - -
- - When requesting multiple fleets, use the pagination parameters to retrieve results - as a set of sequential pages. - - - - If successful, a FleetUtilization object is returned for each requested fleet - ID, unless the fleet identifier is not found. Each fleet utilization object includes - a Location property, which is set to the fleet's home Region. - - - - Some API operations may limit the number of fleet IDs allowed in one request. If a - request exceeds this limit, the request fails and the error message includes the maximum - allowed. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - GameLift - Metrics for Fleets - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeFleetUtilization service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeFleetUtilization service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeFleetUtilization Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information for a registered game server. Information includes game server - status, health check info, and the instance that the game server is running on. - - - - To retrieve game server information, specify the game server ID. If successful, the - requested game server object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServer service method. - - The response from the DescribeGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information for a registered game server. Information includes game server - status, health check info, and the instance that the game server is running on. - - - - To retrieve game server information, specify the game server ID. If successful, the - requested game server object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on a game server group. This operation returns only properties - related to GameLift FleetIQ. To view or update properties for the corresponding Auto - Scaling group, such as launch template, auto scaling policies, and maximum/minimum - group size, access the Auto Scaling group directly. - - - - To get attributes for a game server group, provide a group name or ARN value. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerGroup service method. - - The response from the DescribeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on a game server group. This operation returns only properties - related to GameLift FleetIQ. To view or update properties for the corresponding Auto - Scaling group, such as launch template, auto scaling policies, and maximum/minimum - group size, access the Auto Scaling group directly. - - - - To get attributes for a game server group, provide a group name or ARN value. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves status information about the Amazon EC2 instances associated with a GameLift - FleetIQ game server group. Use this operation to detect when instances are active - or not available to host new game servers. If you are looking for instance configuration - information, call DescribeGameServerGroup or access the corresponding Auto - Scaling group properties. - - - - To request status for all instances in the game server group, provide a game server - group ID only. To request status for specific instances, provide the game server group - ID and one or more instance IDs. Use the pagination parameters to retrieve results - in sequential segments. If successful, a collection of GameServerInstance - objects is returned. - - - - This operation is not designed to be called with every game server claim request; - this practice can cause you to exceed your API limit, which results in errors. Instead, - as a best practice, cache the results and refresh your cache no more than once every - 10 seconds. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerInstances service method. - - The response from the DescribeGameServerInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerInstances Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves status information about the Amazon EC2 instances associated with a GameLift - FleetIQ game server group. Use this operation to detect when instances are active - or not available to host new game servers. If you are looking for instance configuration - information, call DescribeGameServerGroup or access the corresponding Auto - Scaling group properties. - - - - To request status for all instances in the game server group, provide a game server - group ID only. To request status for specific instances, provide the game server group - ID and one or more instance IDs. Use the pagination parameters to retrieve results - in sequential segments. If successful, a collection of GameServerInstance - objects is returned. - - - - This operation is not designed to be called with every game server claim request; - this practice can cause you to exceed your API limit, which results in errors. Instead, - as a best practice, cache the results and refresh your cache no more than once every - 10 seconds. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameServerInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameServerInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameServerInstances Operation - - - - Retrieves additional game session properties, including the game session protection - policy in force, a set of one or more game sessions in a specific fleet location. - You can optionally filter the results by current game session status. Alternatively, - use SearchGameSessions to request a set of active game sessions that are filtered - by certain criteria. To retrieve all game session properties, use DescribeGameSessions. - - - - - This operation can be used in the following ways: - -
  • - - To retrieve details for all game sessions that are currently running on all locations - in a fleet, provide a fleet or alias ID, with an optional status filter. This approach - returns details from the fleet's home Region and all remote locations. - -
  • - - To retrieve details for all game sessions that are currently running on a specific - fleet location, provide a fleet or alias ID and a location name, with optional status - filter. The location can be the fleet's home Region or any remote location. - -
  • - - To retrieve details for a specific game session, provide the game session ID. This - approach looks for the game session ID in all fleets that reside in the AWS Region - defined in the request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSessionDetail object is returned for each game session - that matches the request. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionDetails service method. - - The response from the DescribeGameSessionDetails service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionDetails Operation - - - - Retrieves additional game session properties, including the game session protection - policy in force, a set of one or more game sessions in a specific fleet location. - You can optionally filter the results by current game session status. Alternatively, - use SearchGameSessions to request a set of active game sessions that are filtered - by certain criteria. To retrieve all game session properties, use DescribeGameSessions. - - - - - This operation can be used in the following ways: - -
  • - - To retrieve details for all game sessions that are currently running on all locations - in a fleet, provide a fleet or alias ID, with an optional status filter. This approach - returns details from the fleet's home Region and all remote locations. - -
  • - - To retrieve details for all game sessions that are currently running on a specific - fleet location, provide a fleet or alias ID and a location name, with optional status - filter. The location can be the fleet's home Region or any remote location. - -
  • - - To retrieve details for a specific game session, provide the game session ID. This - approach looks for the game session ID in all fleets that reside in the AWS Region - defined in the request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSessionDetail object is returned for each game session - that matches the request. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionDetails service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionDetails service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionDetails Operation - - - - Retrieves information, including current status, about a game session placement request. - - - - - To get game session placement details, specify the placement ID. - - - - If successful, a GameSessionPlacement object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionPlacement service method. - - The response from the DescribeGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionPlacement Operation - - - - Retrieves information, including current status, about a game session placement request. - - - - - To get game session placement details, specify the placement ID. - - - - If successful, a GameSessionPlacement object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionPlacement Operation - - - - Retrieves the properties for one or more game session queues. When requesting multiple - queues, use the pagination parameters to retrieve results as a set of sequential pages. - If successful, a GameSessionQueue object is returned for each requested queue. - When specifying a list of queues, objects are returned only for queues that currently - exist in the Region. - - - - Learn more - - - - - View Your Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionQueues service method. - - The response from the DescribeGameSessionQueues service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionQueues Operation - - - - Retrieves the properties for one or more game session queues. When requesting multiple - queues, use the pagination parameters to retrieve results as a set of sequential pages. - If successful, a GameSessionQueue object is returned for each requested queue. - When specifying a list of queues, objects are returned only for queues that currently - exist in the Region. - - - - Learn more - - - - - View Your Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessionQueues service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessionQueues service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessionQueues Operation - - - - Retrieves a set of one or more game sessions in a specific fleet location. You can - optionally filter the results by current game session status. Alternatively, use SearchGameSessions - to request a set of active game sessions that are filtered by certain criteria. To - retrieve the protection policy for game sessions, use DescribeGameSessionDetails. - - - - This operation can be used in the following ways: - -
  • - - To retrieve all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID, with an optional status filter. This approach returns - all game sessions in the fleet's home Region and all remote locations. - -
  • - - To retrieve all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name, with optional status filter. The - location can be the fleet's home Region or any remote location. - -
  • - - To retrieve a specific game session, provide the game session ID. This approach looks - for the game session ID in all fleets that reside in the AWS Region defined in the - request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. - - - - Available in GameLift Local. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessions service method. - - The response from the DescribeGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessions Operation - - - - Retrieves a set of one or more game sessions in a specific fleet location. You can - optionally filter the results by current game session status. Alternatively, use SearchGameSessions - to request a set of active game sessions that are filtered by certain criteria. To - retrieve the protection policy for game sessions, use DescribeGameSessionDetails. - - - - This operation can be used in the following ways: - -
  • - - To retrieve all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID, with an optional status filter. This approach returns - all game sessions in the fleet's home Region and all remote locations. - -
  • - - To retrieve all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name, with optional status filter. The - location can be the fleet's home Region or any remote location. - -
  • - - To retrieve a specific game session, provide the game session ID. This approach looks - for the game session ID in all fleets that reside in the AWS Region defined in the - request. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. - - - - Available in GameLift Local. - - - - Learn more - - - - Find - a game session - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeGameSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeGameSessions Operation - - - - Retrieves information about a fleet's instances, including instance IDs, connection - data, and status. - - - - This operation can be used in the following ways: - -
  • - - To get information on all instances that are deployed to a fleet's home Region, provide - the fleet ID. - -
  • - - To get information on all instances that are deployed to a fleet's remote location, - provide the fleet ID and location name. - -
  • - - To get information on a specific instance in a fleet, provide the fleet ID and instance - ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, an Instance object is returned for each requested instance. - Instances are not returned in any particular order. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeInstances service method. - - The response from the DescribeInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeInstances Operation - - - - Retrieves information about a fleet's instances, including instance IDs, connection - data, and status. - - - - This operation can be used in the following ways: - -
  • - - To get information on all instances that are deployed to a fleet's home Region, provide - the fleet ID. - -
  • - - To get information on all instances that are deployed to a fleet's remote location, - provide the fleet ID and location name. - -
  • - - To get information on a specific instance in a fleet, provide the fleet ID and instance - ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, an Instance object is returned for each requested instance. - Instances are not returned in any particular order. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the DescribeInstances service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeInstances service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeInstances Operation - - - - Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, - including--after a successful match is made--connection information for the resulting - new game session. - - - - To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - is successful, a ticket object is returned for each requested ID that currently exists. - - - - This operation is not designed to be continually called to track matchmaking ticket - status. This practice can cause you to exceed your API limit, which results in errors. - Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to - receive notifications, and provide the topic ARN in the matchmaking configuration. - Continuously poling ticket status with DescribeMatchmaking should only be used - for games in development with low matchmaking usage. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmaking service method. - - The response from the DescribeMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmaking Operation - - - - Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, - including--after a successful match is made--connection information for the resulting - new game session. - - - - To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - is successful, a ticket object is returned for each requested ID that currently exists. - - - - This operation is not designed to be continually called to track matchmaking ticket - status. This practice can cause you to exceed your API limit, which results in errors. - Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to - receive notifications, and provide the topic ARN in the matchmaking configuration. - Continuously poling ticket status with DescribeMatchmaking should only be used - for games in development with low matchmaking usage. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmaking Operation - - - - Retrieves the details of FlexMatch matchmaking configurations. - - - - This operation offers the following options: (1) retrieve all matchmaking configurations, - (2) retrieve configurations for a specified list, or (3) retrieve all configurations - that use a specified rule set name. When requesting multiple items, use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a configuration is returned for each requested name. When specifying - a list of names, only configurations that currently exist are returned. - - - - Learn more - - - - - Setting up FlexMatch matchmakers - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingConfigurations service method. - - The response from the DescribeMatchmakingConfigurations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingConfigurations Operation - - - - Retrieves the details of FlexMatch matchmaking configurations. - - - - This operation offers the following options: (1) retrieve all matchmaking configurations, - (2) retrieve configurations for a specified list, or (3) retrieve all configurations - that use a specified rule set name. When requesting multiple items, use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a configuration is returned for each requested name. When specifying - a list of names, only configurations that currently exist are returned. - - - - Learn more - - - - - Setting up FlexMatch matchmakers - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmakingConfigurations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingConfigurations Operation - - - - Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - rule sets for the Region, or provide a list of one or more rule set names. When requesting - multiple items, use the pagination parameters to retrieve results as a set of sequential - pages. If successful, a rule set is returned for each requested name. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingRuleSets service method. - - The response from the DescribeMatchmakingRuleSets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingRuleSets Operation - - - - Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - rule sets for the Region, or provide a list of one or more rule set names. When requesting - multiple items, use the pagination parameters to retrieve results as a set of sequential - pages. If successful, a rule set is returned for each requested name. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the DescribeMatchmakingRuleSets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeMatchmakingRuleSets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for DescribeMatchmakingRuleSets Operation - - - - Retrieves properties for one or more player sessions. - - - - This action can be used in the following ways: - -
  • - - To retrieve a specific player session, provide the player session ID only. - -
  • - - To retrieve all player sessions in a game session, provide the game session ID only. - -
  • - - To retrieve all player sessions for a specific player, provide a player ID only. - -
- - To request player sessions, specify either a player session ID, game session ID, or - player ID. You can filter this request by player session status. Use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a PlayerSession object is returned for each session that - matches the request. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the DescribePlayerSessions service method. - - The response from the DescribePlayerSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribePlayerSessions Operation - - - - Retrieves properties for one or more player sessions. - - - - This action can be used in the following ways: - -
  • - - To retrieve a specific player session, provide the player session ID only. - -
  • - - To retrieve all player sessions in a game session, provide the game session ID only. - -
  • - - To retrieve all player sessions for a specific player, provide a player ID only. - -
- - To request player sessions, specify either a player session ID, game session ID, or - player ID. You can filter this request by player session status. Use the pagination - parameters to retrieve results as a set of sequential pages. - - - - If successful, a PlayerSession object is returned for each session that - matches the request. - - - - Available in Amazon GameLift Local. - - - - Related actions - - - - CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions - | StartGameSessionPlacement | DescribeGameSessionPlacement | All - APIs by task - - - Container for the necessary parameters to execute the DescribePlayerSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribePlayerSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribePlayerSessions Operation - - - - Retrieves a fleet's runtime configuration settings. The runtime configuration tells - GameLift which server processes to run (and how) on each instance in the fleet. - - - - To get the runtime configuration that is currently in forces for a fleet, provide - the fleet ID. - - - - If successful, a RuntimeConfiguration object is returned for the requested - fleet. If the requested fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Running - multiple processes on a fleet - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeRuntimeConfiguration service method. - - The response from the DescribeRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeRuntimeConfiguration Operation - - - - Retrieves a fleet's runtime configuration settings. The runtime configuration tells - GameLift which server processes to run (and how) on each instance in the fleet. - - - - To get the runtime configuration that is currently in forces for a fleet, provide - the fleet ID. - - - - If successful, a RuntimeConfiguration object is returned for the requested - fleet. If the requested fleet has been deleted, the result set is empty. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Running - multiple processes on a fleet - - - - Related actions - - - - ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes - | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes - | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration - | DescribeScalingPolicies | All - APIs by task - - - Container for the necessary parameters to execute the DescribeRuntimeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeRuntimeConfiguration Operation - - - - Retrieves all scaling policies applied to a fleet. - - - - To get a fleet's scaling policies, specify the fleet ID. You can filter this request - by policy status, such as to retrieve only active scaling policies. Use the pagination - parameters to retrieve results as a set of sequential pages. If successful, set of - ScalingPolicy objects is returned for the fleet. - - - - A fleet may have all of its scaling policies suspended (StopFleetActions). - This operation does not affect the status of the scaling policies, which remains ACTIVE. - To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes - and check the stopped actions. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScalingPolicies service method. - - The response from the DescribeScalingPolicies service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScalingPolicies Operation - - - - Retrieves all scaling policies applied to a fleet. - - - - To get a fleet's scaling policies, specify the fleet ID. You can filter this request - by policy status, such as to retrieve only active scaling policies. Use the pagination - parameters to retrieve results as a set of sequential pages. If successful, set of - ScalingPolicy objects is returned for the fleet. - - - - A fleet may have all of its scaling policies suspended (StopFleetActions). - This operation does not affect the status of the scaling policies, which remains ACTIVE. - To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes - and check the stopped actions. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScalingPolicies service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeScalingPolicies service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScalingPolicies Operation - - - - Retrieves properties for a Realtime script. - - - - To request a script record, specify the script ID. If successful, an object containing - the script properties is returned. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScript service method. - - The response from the DescribeScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScript Operation - - - - Retrieves properties for a Realtime script. - - - - To request a script record, specify the script ID. If successful, an object containing - the script properties is returned. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the DescribeScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeScript Operation - - - - Retrieves valid VPC peering authorizations that are pending for the AWS account. This - operation returns all VPC peering authorizations and requests for peering. This includes - those initiated and received by this account. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringAuthorizations service method. - - The response from the DescribeVpcPeeringAuthorizations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringAuthorizations Operation - - - - Retrieves valid VPC peering authorizations that are pending for the AWS account. This - operation returns all VPC peering authorizations and requests for peering. This includes - those initiated and received by this account. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringAuthorizations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeVpcPeeringAuthorizations service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringAuthorizations Operation - - - - Retrieves information on VPC peering connections. Use this operation to get peering - information for all fleets or for one specific fleet ID. - - - - To retrieve connection information, call this operation from the AWS account that - is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter - empty to retrieve all connection records. If successful, the retrieved information - includes both active and pending connections. Active connections identify the IpV4 - CIDR block that the VPC uses to connect. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method. - - The response from the DescribeVpcPeeringConnections service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringConnections Operation - - - - Retrieves information on VPC peering connections. Use this operation to get peering - information for all fleets or for one specific fleet ID. - - - - To retrieve connection information, call this operation from the AWS account that - is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter - empty to retrieve all connection records. If successful, the retrieved information - includes both active and pending connections. Active connections identify the IpV4 - CIDR block that the VPC uses to connect. - - - - Related actions - - - - CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | - DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections - | DeleteVpcPeeringConnection | All - APIs by task - - - Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DescribeVpcPeeringConnections service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for DescribeVpcPeeringConnections Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - A unique identifier for the game session to get logs for. - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the GetGameSessionLogUrl service method. - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - A unique identifier for the game session to get logs for. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Retrieves the location of stored game session logs for a specified game session. When - a game session is terminated, GameLift automatically stores the logs in Amazon S3 - and retains them for 14 days. Use this URL to download the logs. - - - - See the AWS - Service Limits page for maximum log file sizes. Log files that exceed this limit - are not saved. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the GetGameSessionLogUrl service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetGameSessionLogUrl service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetGameSessionLogUrl Operation - - - - Requests remote access to a fleet instance. Remote access is useful for debugging, - gathering benchmarking data, or observing activity in real time. - - - - To remotely access an instance, you need credentials that match the operating system - of the instance. For a Windows instance, GameLift returns a user name and password - as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - returns a user name and RSA private key, also as strings, for use with an SSH client. - The private key must be saved in the proper format to a .pem file before - using. If you're making this request using the AWS CLI, saving the secret can be handled - as part of the GetInstanceAccess request, as shown in one of the examples - for this operation. - - - - To request access to a specific instance, specify the IDs of both the instance and - the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. - If successful, an InstanceAccess object is returned that contains the instance's - IP address and a set of credentials. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the GetInstanceAccess service method. - - The response from the GetInstanceAccess service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetInstanceAccess Operation - - - - Requests remote access to a fleet instance. Remote access is useful for debugging, - gathering benchmarking data, or observing activity in real time. - - - - To remotely access an instance, you need credentials that match the operating system - of the instance. For a Windows instance, GameLift returns a user name and password - as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - returns a user name and RSA private key, also as strings, for use with an SSH client. - The private key must be saved in the proper format to a .pem file before - using. If you're making this request using the AWS CLI, saving the secret can be handled - as part of the GetInstanceAccess request, as shown in one of the examples - for this operation. - - - - To request access to a specific instance, specify the IDs of both the instance and - the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. - If successful, an InstanceAccess object is returned that contains the instance's - IP address and a set of credentials. - - - - Learn more - - - - Remotely - Access Fleet Instances - - - - Debug - Fleet Issues - - - - Related actions - - - - DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits - | All - APIs by task - - - Container for the necessary parameters to execute the GetInstanceAccess service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetInstanceAccess service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for GetInstanceAccess Operation - - - - Retrieves all aliases for this AWS account. You can filter the result set by alias - name and/or routing strategy type. Use the pagination parameters to retrieve results - in sequential pages. - - - - Returned aliases are not listed in any particular order. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ListAliases service method. - - The response from the ListAliases service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListAliases Operation - - - - Retrieves all aliases for this AWS account. You can filter the result set by alias - name and/or routing strategy type. Use the pagination parameters to retrieve results - in sequential pages. - - - - Returned aliases are not listed in any particular order. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ListAliases service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListAliases service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListAliases Operation - - - - Retrieves build resources for all builds associated with the AWS account in use. You - can limit results to builds that are in a specific status by using the Status - parameter. Use the pagination parameters to retrieve results in a set of sequential - pages. - - - - Build resources are not listed in any particular order. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the ListBuilds service method. - - The response from the ListBuilds service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListBuilds Operation - - - - Retrieves build resources for all builds associated with the AWS account in use. You - can limit results to builds that are in a specific status by using the Status - parameter. Use the pagination parameters to retrieve results in a set of sequential - pages. - - - - Build resources are not listed in any particular order. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the ListBuilds service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuilds service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListBuilds Operation - - - - Retrieves a collection of fleet resources in an AWS Region. You can call this operation - to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - specify a Region in your request. You can filter the result set to find only those - fleets that are deployed with a specific build or script. For fleets that have multiple - locations, this operation retrieves fleets based on their home Region only. - - - - This operation can be used in the following ways: - -
  • - - To get a list of all fleets in a Region, don't provide a build or script identifier. - - -
  • - - To get a list of all fleets where a specific custom game build is deployed, provide - the build ID. - -
  • - - To get a list of all Realtime Servers fleets with a specific configuration script, - provide the script ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a list of fleet IDs that match the request parameters is returned. - A NextToken value is also returned if there are more result pages to retrieve. - - - - Fleet resources are not listed in a particular order. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the ListFleets service method. - - The response from the ListFleets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListFleets Operation - - - - Retrieves a collection of fleet resources in an AWS Region. You can call this operation - to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - specify a Region in your request. You can filter the result set to find only those - fleets that are deployed with a specific build or script. For fleets that have multiple - locations, this operation retrieves fleets based on their home Region only. - - - - This operation can be used in the following ways: - -
  • - - To get a list of all fleets in a Region, don't provide a build or script identifier. - - -
  • - - To get a list of all fleets where a specific custom game build is deployed, provide - the build ID. - -
  • - - To get a list of all Realtime Servers fleets with a specific configuration script, - provide the script ID. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a list of fleet IDs that match the request parameters is returned. - A NextToken value is also returned if there are more result pages to retrieve. - - - - Fleet resources are not listed in a particular order. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the ListFleets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListFleets service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListFleets Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers groups that exist in the current AWS account - for the selected Region. Use the pagination parameters to retrieve results in a set - of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServerGroups service method. - - The response from the ListGameServerGroups service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServerGroups Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers groups that exist in the current AWS account - for the selected Region. Use the pagination parameters to retrieve results in a set - of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServerGroups service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGameServerGroups service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServerGroups Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers that are currently active in a specified - game server group. You can opt to sort the list by game server age. Use the pagination - parameters to retrieve results in a set of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServers service method. - - The response from the ListGameServers service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServers Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Retrieves information on all game servers that are currently active in a specified - game server group. You can opt to sort the list by game server age. Use the pagination - parameters to retrieve results in a set of sequential segments. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the ListGameServers service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListGameServers service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListGameServers Operation - - - - Retrieves script records for all Realtime scripts that are associated with the AWS - account in use. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the ListScripts service method. - - The response from the ListScripts service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListScripts Operation - - - - Retrieves script records for all Realtime scripts that are associated with the AWS - account in use. - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the ListScripts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListScripts service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ListScripts Operation - - - - Retrieves all tags that are assigned to a GameLift resource. Resource tags are used - to organize AWS resources for a range of purposes. This operation handles the permissions - necessary to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To list tags for a resource, specify the unique ARN value for the resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - The response from the ListTagsForResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for ListTagsForResource Operation - - - - Retrieves all tags that are assigned to a GameLift resource. Resource tags are used - to organize AWS resources for a range of purposes. This operation handles the permissions - necessary to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To list tags for a resource, specify the unique ARN value for the resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the ListTagsForResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListTagsForResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for ListTagsForResource Operation - - - - Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically - scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs - Amazon GameLift to track a fleet metric and automatically change the fleet's capacity - when a certain threshold is reached. There are two types of scaling policies: target-based - and rule-based. Use a target-based policy to quickly and efficiently manage fleet - scaling; this option is the most commonly used. Use rule-based policies when you need - to exert fine-grained control over auto-scaling. - - - - Fleets can have multiple scaling policies of each type in force at the same time; - you can have one target-based policy, one or multiple rule-based scaling policies, - or both. We recommend caution, however, because multiple auto-scaling policies can - have unintended consequences. - - - - You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions - with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions - with the same fleet action. To stop just one scaling policy--or to permanently remove - it, you must delete the policy with DeleteScalingPolicy. - - - - Learn more about how to work with auto-scaling in Set - Up Fleet Automatic Scaling. - - - - Target-based policy - - - - A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric - tells us how much of a fleet's hosting capacity is ready to host game sessions but - is not currently in use. This is the fleet's buffer; it measures the additional player - demand that the fleet could handle at current capacity. With a target-based policy, - you set your ideal buffer size and leave it to Amazon GameLift to take whatever action - is needed to maintain that target. - - - - For example, you might choose to maintain a 10% buffer for a fleet that has the capacity - to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take - action whenever the fleet's available capacity falls below or rises above 10 game - sessions. Amazon GameLift will start new instances or stop unused instances in order - to return to the 10% buffer. - - - - To create or update a target-based policy, specify a fleet ID and name, and set the - policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - and reference a TargetConfiguration object with your desired buffer value. - Exclude all other parameters. On a successful request, the policy name is returned. - The scaling policy is automatically in force as soon as it's successfully created. - If the fleet's auto-scaling actions are temporarily suspended, the new policy will - be in force once the fleet actions are restarted. - - - - Rule-based policy - - - - A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies - the type of action to initiate when triggered. With a rule-based policy, you can select - from several available fleet metrics. Each policy specifies whether to scale up or - scale down (and by how much), so you need one policy for each type of action. - - - - For example, a policy may make the following statement: "If the percentage of idle - instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - by 10%." - - - - A policy's rule statement has the following structure: - - - - If [MetricName] is [ComparisonOperator] [Threshold] - for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] - to/by [ScalingAdjustment]. - - - - To implement the example, the rule statement would look like this: - - - - If [PercentIdleInstances] is [GreaterThanThreshold] [20] - for [15] minutes, then [PercentChangeInCapacity] to/by [10]. - - - - To create or update a scaling policy, specify a unique combination of name and fleet - ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - rule statement. On a successful request, the policy name is returned. Scaling policies - are automatically in force as soon as they're successfully created. If the fleet's - auto-scaling actions are temporarily suspended, the new policy will be in force once - the fleet actions are restarted. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the PutScalingPolicy service method. - - The response from the PutScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for PutScalingPolicy Operation - - - - Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically - scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs - Amazon GameLift to track a fleet metric and automatically change the fleet's capacity - when a certain threshold is reached. There are two types of scaling policies: target-based - and rule-based. Use a target-based policy to quickly and efficiently manage fleet - scaling; this option is the most commonly used. Use rule-based policies when you need - to exert fine-grained control over auto-scaling. - - - - Fleets can have multiple scaling policies of each type in force at the same time; - you can have one target-based policy, one or multiple rule-based scaling policies, - or both. We recommend caution, however, because multiple auto-scaling policies can - have unintended consequences. - - - - You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions - with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions - with the same fleet action. To stop just one scaling policy--or to permanently remove - it, you must delete the policy with DeleteScalingPolicy. - - - - Learn more about how to work with auto-scaling in Set - Up Fleet Automatic Scaling. - - - - Target-based policy - - - - A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric - tells us how much of a fleet's hosting capacity is ready to host game sessions but - is not currently in use. This is the fleet's buffer; it measures the additional player - demand that the fleet could handle at current capacity. With a target-based policy, - you set your ideal buffer size and leave it to Amazon GameLift to take whatever action - is needed to maintain that target. - - - - For example, you might choose to maintain a 10% buffer for a fleet that has the capacity - to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take - action whenever the fleet's available capacity falls below or rises above 10 game - sessions. Amazon GameLift will start new instances or stop unused instances in order - to return to the 10% buffer. - - - - To create or update a target-based policy, specify a fleet ID and name, and set the - policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - and reference a TargetConfiguration object with your desired buffer value. - Exclude all other parameters. On a successful request, the policy name is returned. - The scaling policy is automatically in force as soon as it's successfully created. - If the fleet's auto-scaling actions are temporarily suspended, the new policy will - be in force once the fleet actions are restarted. - - - - Rule-based policy - - - - A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies - the type of action to initiate when triggered. With a rule-based policy, you can select - from several available fleet metrics. Each policy specifies whether to scale up or - scale down (and by how much), so you need one policy for each type of action. - - - - For example, a policy may make the following statement: "If the percentage of idle - instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - by 10%." - - - - A policy's rule statement has the following structure: - - - - If [MetricName] is [ComparisonOperator] [Threshold] - for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] - to/by [ScalingAdjustment]. - - - - To implement the example, the rule statement would look like this: - - - - If [PercentIdleInstances] is [GreaterThanThreshold] [20] - for [15] minutes, then [PercentChangeInCapacity] to/by [10]. - - - - To create or update a scaling policy, specify a unique combination of name and fleet - ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - rule statement. On a successful request, the policy name is returned. Scaling policies - are automatically in force as soon as they're successfully created. If the fleet's - auto-scaling actions are temporarily suspended, the new policy will be in force once - the fleet actions are restarted. - - - - Related actions - - - - DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits - | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy - | StopFleetActions | StartFleetActions | All - APIs by task - - - Container for the necessary parameters to execute the PutScalingPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutScalingPolicy service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for PutScalingPolicy Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a new game server resource and notifies GameLift FleetIQ that the game server - is ready to host gameplay and players. This operation is called by a game server process - that is running on an instance in a game server group. Registering game servers enables - GameLift FleetIQ to track available game servers and enables game clients and services - to claim a game server for a new game session. - - - - To register a game server, identify the game server group and instance where the game - server is running, and provide a unique identifier for the game server. You can also - include connection and game server data. When a game client or service requests a - game server by calling ClaimGameServer, this information is returned in the - response. - - - - Once a game server is successfully registered, it is put in status AVAILABLE. - A request to register a game server may fail if the instance it is running on is in - the process of shutting down as part of instance balancing or scale-down activity. - - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the RegisterGameServer service method. - - The response from the RegisterGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RegisterGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Creates a new game server resource and notifies GameLift FleetIQ that the game server - is ready to host gameplay and players. This operation is called by a game server process - that is running on an instance in a game server group. Registering game servers enables - GameLift FleetIQ to track available game servers and enables game clients and services - to claim a game server for a new game session. - - - - To register a game server, identify the game server group and instance where the game - server is running, and provide a unique identifier for the game server. You can also - include connection and game server data. When a game client or service requests a - game server by calling ClaimGameServer, this information is returned in the - response. - - - - Once a game server is successfully registered, it is put in status AVAILABLE. - A request to register a game server may fail if the instance it is running on is in - the process of shutting down as part of instance balancing or scale-down activity. - - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the RegisterGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RegisterGameServer service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RegisterGameServer Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the RequestUploadCredentials service method. - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves a fresh set of credentials for use when uploading a new set of game build - files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; - see CreateBuild. - - - - To request new credentials, specify the build ID as returned with an initial CreateBuild - request. If successful, a new set of credentials are returned, along with the S3 storage - location associated with the build ID. - - - - Learn more - - - - - Create a Build with Files in S3 - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the RequestUploadCredentials service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the RequestUploadCredentials service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for RequestUploadCredentials Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value. - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ResolveAlias service method. - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - Retrieves the fleet ID that an alias is currently pointing to. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the ResolveAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResolveAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResolveAlias Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Reinstates activity on a game server group after it has been suspended. A game server - group might be suspended by theSuspendGameServerGroup operation, or it might - be suspended involuntarily due to a configuration problem. In the second case, you - can manually resume activity on the group once the configuration problem has been - resolved. Refer to the game server group status and status reason for more information - on why group activity is suspended. - - - - To resume activity, specify a game server group ARN and the type of activity to be - resumed. If successful, a GameServerGroup object is returned showing that the - resumed activity is no longer listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ResumeGameServerGroup service method. - - The response from the ResumeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResumeGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Reinstates activity on a game server group after it has been suspended. A game server - group might be suspended by theSuspendGameServerGroup operation, or it might - be suspended involuntarily due to a configuration problem. In the second case, you - can manually resume activity on the group once the configuration problem has been - resolved. Refer to the game server group status and status reason for more information - on why group activity is suspended. - - - - To resume activity, specify a game server group ARN and the type of activity to be - resumed. If successful, a GameServerGroup object is returned showing that the - resumed activity is no longer listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the ResumeGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ResumeGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for ResumeGameServerGroup Operation - - - - Retrieves all active game sessions that match a set of search criteria and sorts them - into a specified order. - - - - When searching for game sessions, you specify exactly where you want to search and - provide a search filter expression, a sort expression, or both. A search request can - search only one fleet, but it can search all of a fleet's locations. - - - - This operation can be used in the following ways: - -
  • - - To search all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID. This approach returns game sessions in the fleet's home - Region and all remote locations that fit the search criteria. - -
  • - - To search all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name. For location, you can specify a fleet's - home Region or any remote location. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. Search finds game sessions that are in ACTIVE - status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. - - - - You can search or sort by the following game session attributes: - -
  • - - gameSessionId -- A unique identifier for the game session. You can use either - a GameSessionId or GameSessionArn value. - -
  • - - gameSessionName -- Name assigned to a game session. This value is set when - requesting a new game session with CreateGameSession or updating with UpdateGameSession. - Game session names do not need to be unique to a game session. - -
  • - - gameSessionProperties -- Custom data defined in a game session's GameProperty - parameter. GameProperty values are stored as key:value pairs; the filter - expression must indicate the key and a string to search the data values for. For example, - to search for game sessions with custom data containing the key:value pair "gameMode:brawl", - specify the following: gameSessionProperties.gameMode = "brawl". All - custom data values are searched as strings. - -
  • - - maximumSessions -- Maximum number of player sessions allowed for a game session. - This value is set when requesting a new game session with CreateGameSession - or updating with UpdateGameSession. - -
  • - - creationTimeMillis -- Value indicating when a game session was created. It - is expressed in Unix time as milliseconds. - -
  • - - playerSessionCount -- Number of players currently connected to a game session. - This value changes rapidly as players join the session or drop out. - -
  • - - hasAvailablePlayerSessions -- Boolean value indicating whether a game session - has reached its maximum number of players. It is highly recommended that all search - requests include this filter attribute to optimize search performance and return only - sessions that players can join. - -
- - Returned values for playerSessionCount and hasAvailablePlayerSessions - change quickly as players join sessions and others drop out. Results should be considered - a snapshot in time. Be sure to refresh search results often, and handle sessions that - fill up before a player can join. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the SearchGameSessions service method. - - The response from the SearchGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SearchGameSessions Operation - - - - Retrieves all active game sessions that match a set of search criteria and sorts them - into a specified order. - - - - When searching for game sessions, you specify exactly where you want to search and - provide a search filter expression, a sort expression, or both. A search request can - search only one fleet, but it can search all of a fleet's locations. - - - - This operation can be used in the following ways: - -
  • - - To search all game sessions that are currently running on all locations in a fleet, - provide a fleet or alias ID. This approach returns game sessions in the fleet's home - Region and all remote locations that fit the search criteria. - -
  • - - To search all game sessions that are currently running on a specific fleet location, - provide a fleet or alias ID and a location name. For location, you can specify a fleet's - home Region or any remote location. - -
- - Use the pagination parameters to retrieve results as a set of sequential pages. - - - - If successful, a GameSession object is returned for each game session - that matches the request. Search finds game sessions that are in ACTIVE - status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. - - - - You can search or sort by the following game session attributes: - -
  • - - gameSessionId -- A unique identifier for the game session. You can use either - a GameSessionId or GameSessionArn value. - -
  • - - gameSessionName -- Name assigned to a game session. This value is set when - requesting a new game session with CreateGameSession or updating with UpdateGameSession. - Game session names do not need to be unique to a game session. - -
  • - - gameSessionProperties -- Custom data defined in a game session's GameProperty - parameter. GameProperty values are stored as key:value pairs; the filter - expression must indicate the key and a string to search the data values for. For example, - to search for game sessions with custom data containing the key:value pair "gameMode:brawl", - specify the following: gameSessionProperties.gameMode = "brawl". All - custom data values are searched as strings. - -
  • - - maximumSessions -- Maximum number of player sessions allowed for a game session. - This value is set when requesting a new game session with CreateGameSession - or updating with UpdateGameSession. - -
  • - - creationTimeMillis -- Value indicating when a game session was created. It - is expressed in Unix time as milliseconds. - -
  • - - playerSessionCount -- Number of players currently connected to a game session. - This value changes rapidly as players join the session or drop out. - -
  • - - hasAvailablePlayerSessions -- Boolean value indicating whether a game session - has reached its maximum number of players. It is highly recommended that all search - requests include this filter attribute to optimize search performance and return only - sessions that players can join. - -
- - Returned values for playerSessionCount and hasAvailablePlayerSessions - change quickly as players join sessions and others drop out. Results should be considered - a snapshot in time. Be sure to refresh search results often, and handle sessions that - fill up before a player can join. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the SearchGameSessions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SearchGameSessions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The service is unable to resolve the routing for a particular alias because it has - a terminal RoutingStrategy associated with it. The message returned in this - exception is the message defined in the routing strategy itself. Such requests should - only be retried if the routing strategy for the specified alias is modified. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SearchGameSessions Operation - - - - Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. - For multi-location fleets, fleet actions are managed separately for each location. - Currently, this operation is used to restart a fleet's auto-scaling activity. - - - - This operation can be used in the following ways: - -
  • - - To restart actions on instances in the fleet's home Region, provide a fleet ID and - the type of actions to resume. - -
  • - - To restart actions on instances in one of the fleet's remote locations, provide a - fleet ID, a location name, and the type of actions to resume. - -
- - If successful, GameLift once again initiates scaling events as triggered by the fleet's - scaling policies. If actions on the fleet location were never stopped, this operation - will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes - or DescribeFleetLocationAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StartFleetActions service method. - - The response from the StartFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartFleetActions Operation - - - - Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. - For multi-location fleets, fleet actions are managed separately for each location. - Currently, this operation is used to restart a fleet's auto-scaling activity. - - - - This operation can be used in the following ways: - -
  • - - To restart actions on instances in the fleet's home Region, provide a fleet ID and - the type of actions to resume. - -
  • - - To restart actions on instances in one of the fleet's remote locations, provide a - fleet ID, a location name, and the type of actions to resume. - -
- - If successful, GameLift once again initiates scaling events as triggered by the fleet's - scaling policies. If actions on the fleet location were never stopped, this operation - will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes - or DescribeFleetLocationAttributes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StartFleetActions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartFleetActions Operation - - - - Places a request for a new game session in a queue (see CreateGameSessionQueue). - When processing a placement request, Amazon GameLift searches for available resources - on the queue's destinations, scanning each until it finds resources or the placement - request times out. - - - - A game session placement request can also request player sessions. When a new game - session is successfully created, Amazon GameLift creates a player session for each - player included in the request. - - - - When placing a game session, by default Amazon GameLift tries each fleet in the order - they are listed in the queue configuration. Ideally, a queue's destinations are listed - in preference order. - - - - Alternatively, when requesting a game session with players, you can also provide latency - data for each player in relevant Regions. Latency data indicates the performance lag - a player experiences when connected to a fleet in the Region. Amazon GameLift uses - latency data to reorder the list of destinations to place the game session in a Region - with minimal lag. If latency data is provided for multiple players, Amazon GameLift - calculates each Region's average lag for all players and reorders to get the best - game play across all players. - - - - To place a new game session request, specify the following: - -
  • - - The queue name and a set of game session properties and settings - -
  • - - A unique ID (such as a UUID) for the placement. You use this ID to track the status - of the placement request - -
  • - - (Optional) A set of player data and a unique player ID for each player that you are - joining to the new game session (player data is optional, but if you include it, you - must also provide a unique ID for each player) - -
  • - - Latency data for all players (if you want to optimize game play for the players) - -
- - If successful, a new game session placement is created. - - - - To track the status of a placement request, call DescribeGameSessionPlacement - and check the request's status. If the status is FULFILLED, a new game - session has been created and a game session ARN and Region are referenced. If the - placement request times out, you can resubmit the request or retry it with a different - queue. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StartGameSessionPlacement service method. - - The response from the StartGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartGameSessionPlacement Operation - - - - Places a request for a new game session in a queue (see CreateGameSessionQueue). - When processing a placement request, Amazon GameLift searches for available resources - on the queue's destinations, scanning each until it finds resources or the placement - request times out. - - - - A game session placement request can also request player sessions. When a new game - session is successfully created, Amazon GameLift creates a player session for each - player included in the request. - - - - When placing a game session, by default Amazon GameLift tries each fleet in the order - they are listed in the queue configuration. Ideally, a queue's destinations are listed - in preference order. - - - - Alternatively, when requesting a game session with players, you can also provide latency - data for each player in relevant Regions. Latency data indicates the performance lag - a player experiences when connected to a fleet in the Region. Amazon GameLift uses - latency data to reorder the list of destinations to place the game session in a Region - with minimal lag. If latency data is provided for multiple players, Amazon GameLift - calculates each Region's average lag for all players and reorders to get the best - game play across all players. - - - - To place a new game session request, specify the following: - -
  • - - The queue name and a set of game session properties and settings - -
  • - - A unique ID (such as a UUID) for the placement. You use this ID to track the status - of the placement request - -
  • - - (Optional) A set of player data and a unique player ID for each player that you are - joining to the new game session (player data is optional, but if you include it, you - must also provide a unique ID for each player) - -
  • - - Latency data for all players (if you want to optimize game play for the players) - -
- - If successful, a new game session placement is created. - - - - To track the status of a placement request, call DescribeGameSessionPlacement - and check the request's status. If the status is FULFILLED, a new game - session has been created and a game session ARN and Region are referenced. If the - placement request times out, you can resubmit the request or retry it with a different - queue. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StartGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StartGameSessionPlacement Operation - - - - Finds new players to fill open slots in currently running game sessions. The backfill - match process is essentially identical to the process of forming new matches. Backfill - requests use the same matchmaker that was used to make the original match, and they - provide matchmaking data for all players currently in the game session. FlexMatch - uses this information to select new players so that backfilled match continues to - meet the original match requirements. - - - - When using FlexMatch with GameLift managed hosting, you can request a backfill match - from a client service by calling this operation with a GameSession identifier. - You also have the option of making backfill requests directly from your game server. - In response to a request, FlexMatch creates player sessions for the new players, updates - the GameSession resource, and sends updated matchmaking data to the game - server. You can request a backfill match at any point after a game session is started. - Each game session can have only one active backfill request at a time; a subsequent - request automatically replaces the earlier request. - - - - When using FlexMatch as a standalone component, request a backfill match by calling - this operation without a game session identifier. As with newly formed matches, matchmaking - results are returned in a matchmaking event so that your game can update the game - session that is being backfilled. - - - - To request a backfill match, specify a unique ticket ID, the original matchmaking - configuration, and matchmaking data for all current players in the game session being - backfilled. Optionally, specify the GameSession ARN. If successful, a - match backfill ticket is created and returned with status set to QUEUED. Track the - status of backfill tickets using the same method for tracking tickets for new matches. - - - - Learn more - - - - - Backfill existing games with FlexMatch - - - - - Matchmaking events (reference) - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchBackfill service method. - - The response from the StartMatchBackfill service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchBackfill Operation - - - - Finds new players to fill open slots in currently running game sessions. The backfill - match process is essentially identical to the process of forming new matches. Backfill - requests use the same matchmaker that was used to make the original match, and they - provide matchmaking data for all players currently in the game session. FlexMatch - uses this information to select new players so that backfilled match continues to - meet the original match requirements. - - - - When using FlexMatch with GameLift managed hosting, you can request a backfill match - from a client service by calling this operation with a GameSession identifier. - You also have the option of making backfill requests directly from your game server. - In response to a request, FlexMatch creates player sessions for the new players, updates - the GameSession resource, and sends updated matchmaking data to the game - server. You can request a backfill match at any point after a game session is started. - Each game session can have only one active backfill request at a time; a subsequent - request automatically replaces the earlier request. - - - - When using FlexMatch as a standalone component, request a backfill match by calling - this operation without a game session identifier. As with newly formed matches, matchmaking - results are returned in a matchmaking event so that your game can update the game - session that is being backfilled. - - - - To request a backfill match, specify a unique ticket ID, the original matchmaking - configuration, and matchmaking data for all current players in the game session being - backfilled. Optionally, specify the GameSession ARN. If successful, a - match backfill ticket is created and returned with status set to QUEUED. Track the - status of backfill tickets using the same method for tracking tickets for new matches. - - - - Learn more - - - - - Backfill existing games with FlexMatch - - - - - Matchmaking events (reference) - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchBackfill service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartMatchBackfill service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchBackfill Operation - - - - Uses FlexMatch to create a game match for a group of players based on custom matchmaking - rules. With games that use GameLift managed hosting, this operation also triggers - GameLift to find hosting resources and start a new game session for the new match. - Each matchmaking request includes information on one or more players and specifies - the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch - attempts to build a match that includes all players in the request, placing them in - the same team and finding additional players as needed to fill the match. - - - - To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - and include the players to be matched. You must also include any player attributes - that are required by the matchmaking configuration's rule set. If successful, a matchmaking - ticket is returned with status set to QUEUED. - - - - Track matchmaking events to respond as needed and acquire game session connection - information for successfully completed matches. Ticket status updates are tracked - using event notification through Amazon Simple Notification Service (SNS), which is - defined in the matchmaking configuration. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchmaking service method. - - The response from the StartMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchmaking Operation - - - - Uses FlexMatch to create a game match for a group of players based on custom matchmaking - rules. With games that use GameLift managed hosting, this operation also triggers - GameLift to find hosting resources and start a new game session for the new match. - Each matchmaking request includes information on one or more players and specifies - the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch - attempts to build a match that includes all players in the request, placing them in - the same team and finding additional players as needed to fill the match. - - - - To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - and include the players to be matched. You must also include any player attributes - that are required by the matchmaking configuration's rule set. If successful, a matchmaking - ticket is returned with status set to QUEUED. - - - - Track matchmaking events to respond as needed and acquire game session connection - information for successfully completed matches. Ticket status updates are tracked - using event notification through Amazon Simple Notification Service (SNS), which is - defined in the matchmaking configuration. - - - - Learn more - - - - - Add FlexMatch to a game client - - - - - Set Up FlexMatch event notification - - - - - How GameLift FlexMatch works - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StartMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StartMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StartMatchmaking Operation - - - - Suspends certain types of activity in a fleet location. Currently, this operation - is used to stop auto-scaling activity. For multi-location fleets, fleet actions are - managed separately for each location. - - - - Stopping fleet actions has several potential purposes. It allows you to temporarily - stop auto-scaling activity but retain your scaling policies for use in the future. - For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out - of it for certain locations. - - - - This operation can be used in the following ways: - -
  • - - To stop actions on instances in the fleet's home Region, provide a fleet ID and the - type of actions to suspend. - -
  • - - To stop actions on instances in one of the fleet's remote locations, provide a fleet - ID, a location name, and the type of actions to suspend. - -
- - If successful, GameLift no longer initiates scaling events except in response to manual - changes using UpdateFleetCapacity. You can view a fleet's stopped actions using - DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended - activity can be restarted using StartFleetActions. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StopFleetActions service method. - - The response from the StopFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopFleetActions Operation - - - - Suspends certain types of activity in a fleet location. Currently, this operation - is used to stop auto-scaling activity. For multi-location fleets, fleet actions are - managed separately for each location. - - - - Stopping fleet actions has several potential purposes. It allows you to temporarily - stop auto-scaling activity but retain your scaling policies for use in the future. - For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out - of it for certain locations. - - - - This operation can be used in the following ways: - -
  • - - To stop actions on instances in the fleet's home Region, provide a fleet ID and the - type of actions to suspend. - -
  • - - To stop actions on instances in one of the fleet's remote locations, provide a fleet - ID, a location name, and the type of actions to suspend. - -
- - If successful, GameLift no longer initiates scaling events except in response to manual - changes using UpdateFleetCapacity. You can view a fleet's stopped actions using - DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended - activity can be restarted using StartFleetActions. - - - - Learn more - - - - Setting - up GameLift Fleets - - - - Related actions - - - - CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits - | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes - | StopFleetActions | DeleteFleet | All - APIs by task - - - Container for the necessary parameters to execute the StopFleetActions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopFleetActions service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopFleetActions Operation - - - - Cancels a game session placement that is in PENDING status. To stop a - placement, provide the placement ID values. If successful, the placement is moved - to CANCELLED status. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StopGameSessionPlacement service method. - - The response from the StopGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopGameSessionPlacement Operation - - - - Cancels a game session placement that is in PENDING status. To stop a - placement, provide the placement ID values. If successful, the placement is moved - to CANCELLED status. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the StopGameSessionPlacement service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopGameSessionPlacement service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for StopGameSessionPlacement Operation - - - - Cancels a matchmaking ticket or match backfill ticket that is currently being processed. - To stop the matchmaking operation, specify the ticket ID. If successful, work on the - ticket is stopped, and the ticket status is changed to CANCELLED. - - - - This call is also used to turn off automatic backfill for an individual game session. - This is for game sessions that are created with a matchmaking configuration that has - automatic backfill enabled. The ticket ID is included in the MatchmakerData - of an updated game session object, which is provided to the game server. - - - - If the operation is successful, the service sends back an empty JSON struct with the - HTTP 200 response (not an empty HTTP body). - - - - Learn more - - - - - Add FlexMatch to a game client - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StopMatchmaking service method. - - The response from the StopMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StopMatchmaking Operation - - - - Cancels a matchmaking ticket or match backfill ticket that is currently being processed. - To stop the matchmaking operation, specify the ticket ID. If successful, work on the - ticket is stopped, and the ticket status is changed to CANCELLED. - - - - This call is also used to turn off automatic backfill for an individual game session. - This is for game sessions that are created with a matchmaking configuration that has - automatic backfill enabled. The ticket ID is included in the MatchmakerData - of an updated game session object, which is provided to the game server. - - - - If the operation is successful, the service sends back an empty JSON struct with the - HTTP 200 response (not an empty HTTP body). - - - - Learn more - - - - - Add FlexMatch to a game client - - - - Related actions - - - - StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch - | StartMatchBackfill | All - APIs by task - - - Container for the necessary parameters to execute the StopMatchmaking service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the StopMatchmaking service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for StopMatchmaking Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Temporarily stops activity on a game server group without terminating instances or - the game server group. You can restart activity by calling ResumeGameServerGroup. - You can suspend the following activity: - -
  • - - Instance type replacement - This activity evaluates the current game hosting - viability of all Spot instance types that are defined for the game server group. It - updates the Auto Scaling group to remove nonviable Spot Instance types, which have - a higher chance of game server interruptions. It then balances capacity across the - remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling - group continues with its current balance, regardless of viability. Instance protection, - utilization metrics, and capacity scaling activities continue to be active. - -
- - To suspend activity, specify a game server group ARN and the type of activity to be - suspended. If successful, a GameServerGroup object is returned showing that - the activity is listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the SuspendGameServerGroup service method. - - The response from the SuspendGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SuspendGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Temporarily stops activity on a game server group without terminating instances or - the game server group. You can restart activity by calling ResumeGameServerGroup. - You can suspend the following activity: - -
  • - - Instance type replacement - This activity evaluates the current game hosting - viability of all Spot instance types that are defined for the game server group. It - updates the Auto Scaling group to remove nonviable Spot Instance types, which have - a higher chance of game server interruptions. It then balances capacity across the - remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling - group continues with its current balance, regardless of viability. Instance protection, - utilization metrics, and capacity scaling activities continue to be active. - -
- - To suspend activity, specify a game server group ARN and the type of activity to be - suspended. If successful, a GameServerGroup object is returned showing that - the activity is listed in SuspendedActions. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the SuspendGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the SuspendGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for SuspendGameServerGroup Operation - - - - Assigns a tag to a GameLift resource. AWS resource tags provide an additional management - tool set. You can use tags to organize resources, create IAM permissions policies - to manage access to groups of resources, customize AWS cost breakdowns, etc. This - operation handles the permissions necessary to manage tags for the following GameLift - resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To add a tag to a resource, specify the unique ARN value for the resource and provide - a tag list containing one or more tags. The operation succeeds even if the list includes - tags that are already assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the TagResource service method. - - The response from the TagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for TagResource Operation - - - - Assigns a tag to a GameLift resource. AWS resource tags provide an additional management - tool set. You can use tags to organize resources, create IAM permissions policies - to manage access to groups of resources, customize AWS cost breakdowns, etc. This - operation handles the permissions necessary to manage tags for the following GameLift - resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To add a tag to a resource, specify the unique ARN value for the resource and provide - a tag list containing one or more tags. The operation succeeds even if the list includes - tags that are already assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the TagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the TagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for TagResource Operation - - - - Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize - AWS resources for a range of purposes. This operation handles the permissions necessary - to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To remove a tag from a resource, specify the unique ARN value for the resource and - provide a string list containing one or more tags to be removed. This operation succeeds - even if the list includes tags that are not currently assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the UntagResource service method. - - The response from the UntagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for UntagResource Operation - - - - Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize - AWS resources for a range of purposes. This operation handles the permissions necessary - to manage tags for the following GameLift resource types: - -
  • - - Build - -
  • - - Script - -
  • - - Fleet - -
  • - - Alias - -
  • - - GameSessionQueue - -
  • - - MatchmakingConfiguration - -
  • - - MatchmakingRuleSet - -
- - To remove a tag from a resource, specify the unique ARN value for the resource and - provide a string list containing one or more tags to be removed. This operation succeeds - even if the list includes tags that are not currently assigned to the specified resource. - - - - Learn more - - - - Tagging - AWS Resources in the AWS General Reference - - - - - AWS Tagging Strategies - - - - Related actions - - - - TagResource | UntagResource | ListTagsForResource | All - APIs by task - - - Container for the necessary parameters to execute the UntagResource service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UntagResource service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested tagging operation did not succeed. This may be due to invalid tag format - or the maximum tag limit may have been exceeded. Resolve the issue before retrying. - - REST API Reference for UntagResource Operation - - - - Updates properties for an alias. To update properties, specify the alias ID to be - updated and provide the information to be changed. To reassign an alias to another - fleet, provide an updated routing strategy. If successful, the updated alias record - is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the UpdateAlias service method. - - The response from the UpdateAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateAlias Operation - - - - Updates properties for an alias. To update properties, specify the alias ID to be - updated and provide the information to be changed. To reassign an alias to another - fleet, provide an updated routing strategy. If successful, the updated alias record - is returned. - - - - Related actions - - - - CreateAlias | ListAliases | DescribeAlias | UpdateAlias - | DeleteAlias | ResolveAlias | All - APIs by task - - - Container for the necessary parameters to execute the UpdateAlias service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateAlias service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateAlias Operation - - - - Updates metadata in a build resource, including the build name and version. To update - the metadata, specify the build ID to update and provide the new values. If successful, - a build object containing the updated metadata is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the UpdateBuild service method. - - The response from the UpdateBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateBuild Operation - - - - Updates metadata in a build resource, including the build name and version. To update - the metadata, specify the build ID to update and provide the new values. If successful, - a build object containing the updated metadata is returned. - - - - Learn more - - - - - Upload a Custom Server Build - - - - Related actions - - - - CreateBuild | ListBuilds | DescribeBuild | UpdateBuild - | DeleteBuild | All - APIs by task - - - Container for the necessary parameters to execute the UpdateBuild service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateBuild service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateBuild Operation - - - - Updates a fleet's mutable attributes, including game session protection and resource - creation limits. - - - - To update fleet attributes, specify the fleet ID and the property values that you - want to change. - - - - If successful, an updated FleetAttributes object is returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetAttributes service method. - - The response from the UpdateFleetAttributes service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetAttributes Operation - - - - Updates a fleet's mutable attributes, including game session protection and resource - creation limits. - - - - To update fleet attributes, specify the fleet ID and the property values that you - want to change. - - - - If successful, an updated FleetAttributes object is returned. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetAttributes service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetAttributes service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetAttributes Operation - - - - Updates capacity settings for a fleet. For fleets with multiple locations, use this - operation to manage capacity settings in each location individually. Fleet capacity - determines the number of game sessions and players that can be hosted based on the - fleet configuration. Use this operation to set the following fleet capacity properties: - - -
  • - - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's - capacity to a value outside of this range, whether the capacity is changed manually - or through automatic scaling. - -
  • - - Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet - location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits - to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider - using automatic scaling to adjust capacity based on player demand. - -
- - This operation can be used in the following ways: - -
  • - - To update capacity for a fleet's home Region, or if the fleet has no remote locations, - omit the Location parameter. The fleet must be in ACTIVE - status. - -
  • - - To update capacity for a fleet's remote location, include the Location - parameter set to the location to be updated. The location must be in ACTIVE - status. - -
- - If successful, capacity settings are updated immediately. In response a change in - desired capacity, GameLift initiates steps to start new instances or terminate existing - instances in the requested fleet location. This continues until the location's active - instance count matches the new desired instance count. You can track a fleet's current - capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. - If the requested desired instance count is higher than the instance type's limit, - the LimitExceeded exception occurs. - - - - Learn more - - - - Scaling - fleet capacity - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetCapacity service method. - - The response from the UpdateFleetCapacity service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetCapacity Operation - - - - Updates capacity settings for a fleet. For fleets with multiple locations, use this - operation to manage capacity settings in each location individually. Fleet capacity - determines the number of game sessions and players that can be hosted based on the - fleet configuration. Use this operation to set the following fleet capacity properties: - - -
  • - - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's - capacity to a value outside of this range, whether the capacity is changed manually - or through automatic scaling. - -
  • - - Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet - location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits - to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider - using automatic scaling to adjust capacity based on player demand. - -
- - This operation can be used in the following ways: - -
  • - - To update capacity for a fleet's home Region, or if the fleet has no remote locations, - omit the Location parameter. The fleet must be in ACTIVE - status. - -
  • - - To update capacity for a fleet's remote location, include the Location - parameter set to the location to be updated. The location must be in ACTIVE - status. - -
- - If successful, capacity settings are updated immediately. In response a change in - desired capacity, GameLift initiates steps to start new instances or terminate existing - instances in the requested fleet location. This continues until the location's active - instance count matches the new desired instance count. You can track a fleet's current - capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. - If the requested desired instance count is higher than the instance type's limit, - the LimitExceeded exception occurs. - - - - Learn more - - - - Scaling - fleet capacity - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetCapacity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetCapacity service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetCapacity Operation - - - - Updates permissions that allow inbound traffic to connect to game sessions that are - being hosted on instances in the fleet. - - - - To update settings, specify the fleet ID to be updated and specify the changes to - be made. List the permissions you want to add in InboundPermissionAuthorizations, - and permissions you want to remove in InboundPermissionRevocations. Permissions - to be removed must match existing fleet permissions. - - - - If successful, the fleet ID for the updated fleet is returned. For fleets with remote - locations, port setting updates can take time to propagate across all locations. You - can check the status of updates in each location by calling DescribeFleetPortSettings - with a location name. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetPortSettings service method. - - The response from the UpdateFleetPortSettings service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetPortSettings Operation - - - - Updates permissions that allow inbound traffic to connect to game sessions that are - being hosted on instances in the fleet. - - - - To update settings, specify the fleet ID to be updated and specify the changes to - be made. List the permissions you want to add in InboundPermissionAuthorizations, - and permissions you want to remove in InboundPermissionRevocations. Permissions - to be removed must match existing fleet permissions. - - - - If successful, the fleet ID for the updated fleet is returned. For fleets with remote - locations, port setting updates can take time to propagate across all locations. You - can check the status of updates in each location by calling DescribeFleetPortSettings - with a location name. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateFleetPortSettings service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateFleetPortSettings service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation would cause the resource to exceed the allowed service limit. - Resolve the issue before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateFleetPortSettings Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates information about a registered game server to help GameLift FleetIQ to track - game server availability. This operation is called by a game server process that is - running on an instance in a game server group. - - - - Use this operation to update the following types of game server information. You can - make all three types of updates in the same request: - -
  • - - To update the game server's utilization status, identify the game server and game - server group and specify the current utilization status. Use this status to identify - when game servers are currently hosting games and when they are available to be claimed. - -
  • - - To report health status, identify the game server and game server group and set health - check to HEALTHY. If a game server does not report health status for - a certain length of time, the game server is no longer considered healthy. As a result, - it will be eventually deregistered from the game server group to avoid affecting utilization - metrics. The best practice is to report health every 60 seconds. - -
  • - - To change game server metadata, provide updated game server data. - -
- - Once a game server is successfully updated, the relevant statuses and timestamps are - updated. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServer service method. - - The response from the UpdateGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates information about a registered game server to help GameLift FleetIQ to track - game server availability. This operation is called by a game server process that is - running on an instance in a game server group. - - - - Use this operation to update the following types of game server information. You can - make all three types of updates in the same request: - -
  • - - To update the game server's utilization status, identify the game server and game - server group and specify the current utilization status. Use this status to identify - when game servers are currently hosting games and when they are available to be claimed. - -
  • - - To report health status, identify the game server and game server group and set health - check to HEALTHY. If a game server does not report health status for - a certain length of time, the game server is no longer considered healthy. As a result, - it will be eventually deregistered from the game server group to avoid affecting utilization - metrics. The best practice is to report health every 60 seconds. - -
  • - - To change game server metadata, provide updated game server data. - -
- - Once a game server is successfully updated, the relevant statuses and timestamps are - updated. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer - | UpdateGameServer | DeregisterGameServer | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServer service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameServer service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServer Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling - group properties are updated on the Auto Scaling group directly, including the launch - template, Auto Scaling policies, and maximum/minimum/desired instance counts. - - - - To update the game server group, specify the game server group ID and provide the - updated values. Before applying the updates, the new values are validated to ensure - that GameLift FleetIQ can continue to perform instance balancing activity. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServerGroup service method. - - The response from the UpdateGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServerGroup Operation - - - - This operation is used with the GameLift FleetIQ solution and game server groups. - - - - - Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling - group properties are updated on the Auto Scaling group directly, including the launch - template, Auto Scaling policies, and maximum/minimum/desired instance counts. - - - - To update the game server group, specify the game server group ID and provide the - updated values. Before applying the updates, the new values are validated to ensure - that GameLift FleetIQ can continue to perform instance balancing activity. If successful, - a GameServerGroup object is returned. - - - - Learn more - - - - GameLift - FleetIQ Guide - - - - Related actions - - - - CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup - | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup - | SuspendGameServerGroup | DescribeGameServerInstances | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameServerGroup service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameServerGroup service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameServerGroup Operation - - - - Updates the mutable properties of a game session. - - - - To update a game session, specify the game session ID and the values you want to change. - - - - - If successful, the updated GameSession object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSession service method. - - The response from the UpdateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSession Operation - - - - Updates the mutable properties of a game session. - - - - To update a game session, specify the game session ID and the values you want to change. - - - - - If successful, the updated GameSession object is returned. - - - - Related actions - - - - CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails - | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl - | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement - | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSession service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameSession service method, as returned by GameLift. - - The requested operation would cause a conflict with the current state of a service - resource associated with the request. Resolve the conflict before retrying this request. - - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the game instance. Resolve the conflict before - retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSession Operation - - - - Updates the configuration of a game session queue, which determines how the queue - processes new game session requests. To update settings, specify the queue name to - be updated and provide the new settings. When updating destinations, provide a complete - list of destinations. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSessionQueue service method. - - The response from the UpdateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSessionQueue Operation - - - - Updates the configuration of a game session queue, which determines how the queue - processes new game session requests. To update settings, specify the queue name to - be updated and provide the new settings. When updating destinations, provide a complete - list of destinations. - - - - Learn more - - - - - Using Multi-Region Queues - - - - Related actions - - - - CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue - | DeleteGameSessionQueue | All - APIs by task - - - Container for the necessary parameters to execute the UpdateGameSessionQueue service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateGameSessionQueue service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateGameSessionQueue Operation - - - - Updates settings for a FlexMatch matchmaking configuration. These changes affect all - matches and game sessions that are created after the update. To update settings, specify - the configuration name to be updated and provide the new settings. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the UpdateMatchmakingConfiguration service method. - - The response from the UpdateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for UpdateMatchmakingConfiguration Operation - - - - Updates settings for a FlexMatch matchmaking configuration. These changes affect all - matches and game sessions that are created after the update. To update settings, specify - the configuration name to be updated and provide the new settings. - - - - Learn more - - - - - Design a FlexMatch matchmaker - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the UpdateMatchmakingConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateMatchmakingConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The requested operation is not supported in the Region specified. - - REST API Reference for UpdateMatchmakingConfiguration Operation - - - - Updates the current runtime configuration for the specified fleet, which tells GameLift - how to launch server processes on all instances in the fleet. You can update a fleet's - runtime configuration at any time after the fleet is created; it does not need to - be in ACTIVE status. - - - - To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration - with an updated set of server process configurations. - - - - If successful, the fleet's runtime configuration settings are updated. Each instance - in the fleet regularly checks for and retrieves updated runtime configurations. Instances - immediately begin complying with the new configuration by launching new server processes - or not replacing existing processes when they shut down. Updating a fleet's runtime - configuration never affects existing server processes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateRuntimeConfiguration service method. - - The response from the UpdateRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateRuntimeConfiguration Operation - - - - Updates the current runtime configuration for the specified fleet, which tells GameLift - how to launch server processes on all instances in the fleet. You can update a fleet's - runtime configuration at any time after the fleet is created; it does not need to - be in ACTIVE status. - - - - To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration - with an updated set of server process configurations. - - - - If successful, the fleet's runtime configuration settings are updated. Each instance - in the fleet regularly checks for and retrieves updated runtime configurations. Instances - immediately begin complying with the new configuration by launching new server processes - or not replacing existing processes when they shut down. Updating a fleet's runtime - configuration never affects existing server processes. - - - - Learn more - - - - Setting - up GameLift fleets - - - - Related actions - - - - CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity - | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions - | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations - | DeleteScalingPolicy | All - APIs by task - - - Container for the necessary parameters to execute the UpdateRuntimeConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateRuntimeConfiguration service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - The requested operation would cause a conflict with the current state of a resource - associated with the request and/or the fleet. Resolve the conflict before retrying. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateRuntimeConfiguration Operation - - - - Updates Realtime script metadata and content. - - - - To update script metadata, specify the script ID and provide updated name and/or version - values. - - - - To update script content, provide an updated zip file by pointing to either a local - file or an Amazon S3 bucket location. You can use either method regardless of how - the original script was uploaded. Use the Version parameter to track updates - to the script. - - - - If the call is successful, the updated metadata is stored in the script record and - a revised script is uploaded to the Amazon GameLift service. Once the script is updated - and acquired by a fleet instance, the new version is used for all new game sessions. - - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the UpdateScript service method. - - The response from the UpdateScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateScript Operation - - - - Updates Realtime script metadata and content. - - - - To update script metadata, specify the script ID and provide updated name and/or version - values. - - - - To update script content, provide an updated zip file by pointing to either a local - file or an Amazon S3 bucket location. You can use either method regardless of how - the original script was uploaded. Use the Version parameter to track updates - to the script. - - - - If the call is successful, the updated metadata is stored in the script record and - a revised script is uploaded to the Amazon GameLift service. Once the script is updated - and acquired by a fleet instance, the new version is used for all new game sessions. - - - - - Learn more - - - - Amazon - GameLift Realtime Servers - - - - Related actions - - - - CreateScript | ListScripts | DescribeScript | UpdateScript - | DeleteScript | All - APIs by task - - - Container for the necessary parameters to execute the UpdateScript service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the UpdateScript service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - A service resource associated with the request could not be found. Clients should - not retry such requests. - - - The client failed authentication. Clients should not retry such requests. - - REST API Reference for UpdateScript Operation - - - - Validates the syntax of a matchmaking rule or rule set. This operation checks that - the rule set is using syntactically correct JSON and that it conforms to allowed property - expressions. To validate syntax, provide a rule set JSON string. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the ValidateMatchmakingRuleSet service method. - - The response from the ValidateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for ValidateMatchmakingRuleSet Operation - - - - Validates the syntax of a matchmaking rule or rule set. This operation checks that - the rule set is using syntactically correct JSON and that it conforms to allowed property - expressions. To validate syntax, provide a rule set JSON string. - - - - Learn more - - - - Related actions - - - - CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations - | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | - CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet - | DeleteMatchmakingRuleSet | All - APIs by task - - - Container for the necessary parameters to execute the ValidateMatchmakingRuleSet service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ValidateMatchmakingRuleSet service method, as returned by GameLift. - - The service encountered an unrecoverable internal failure while processing the request. - Clients can retry such requests immediately or after a waiting period. - - - One or more parameter values in the request are invalid. Correct the invalid parameter - values before retrying. - - - The requested operation is not supported in the Region specified. - - REST API Reference for ValidateMatchmakingRuleSet Operation - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.dll.meta deleted file mode 100644 index f1423709..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 18cf6be9bd17e78449c368338dfbfe44 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml deleted file mode 100644 index 59fb6822..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml +++ /dev/null @@ -1,53714 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Paginators for the service - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this action to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This action concatenates the parts that you provide in the - list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - CompleteMultipartUpload has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this action to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This action concatenates the parts that you provide in the - list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - CompleteMultipartUpload has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - - Deletes the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to DeleteBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method. - - The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation - - - - Deletes the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to DeleteBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Removes OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:PutBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to DeleteBucketOwnershipControls: - - - - Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method. - - The response from the DeleteBucketOwnershipControls service method, as returned by S3. - REST API Reference for DeleteBucketOwnershipControls Operation - - - - Removes OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:PutBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to DeleteBucketOwnershipControls: - - - - Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketOwnershipControls service method, as returned by S3. - REST API Reference for DeleteBucketOwnershipControls Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 User Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 User Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This action enables you to delete multiple objects from a bucket using a single HTTP - request. If you know the object keys that you want to delete, then this action provides - a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete action and returns the result of that delete, success, or failure, - in the response. Note that if the object specified in the request is not found, Amazon - S3 returns the result as deleted. - - - - The action supports two modes for the response: verbose and quiet. By default, the - action uses verbose mode in which the response includes the result of deletion of - each key in your request. In quiet mode the response includes only keys where the - delete action encountered an error. For a successful deletion, the action does not - return any information about the delete in the response body. - - - - When performing this action on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - This action enables you to delete multiple objects from a bucket using a single HTTP - request. If you know the object keys that you want to delete, then this action provides - a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete action and returns the result of that delete, success, or failure, - in the response. Note that if the object specified in the request is not found, Amazon - S3 returns the result as deleted. - - - - The action supports two modes for the response: verbose and quiet. By default, the - action uses verbose mode in which the response includes the result of deletion of - each key in your request. In quiet mode the response includes only keys where the - delete action encountered an error. For a successful deletion, the action does not - return any information about the delete in the response body. - - - - When performing this action on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. If the bucket - does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError. - - - - - For information about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. If the bucket - does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError. - - - - - For information about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Gets the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to GetBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method. - - The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for GetBucketIntelligentTieringConfiguration Operation - - - - Gets the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to GetBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for GetBucketIntelligentTieringConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - The name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - The name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:GetBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to GetBucketOwnershipControls: - - - - Container for the necessary parameters to execute the GetBucketOwnershipControls service method. - - The response from the GetBucketOwnershipControls service method, as returned by S3. - REST API Reference for GetBucketOwnershipControls Operation - - - - Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:GetBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to GetBucketOwnershipControls: - - - - Container for the necessary parameters to execute the GetBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketOwnershipControls service method, as returned by S3. - REST API Reference for GetBucketOwnershipControls Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object in your - bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following action is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object in your - bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following action is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This action is useful to determine if a bucket exists and you have permission to access - it. The action returns a 200 OK if the bucket exists and you have permission - to access it. - - - - If the bucket does not exist or you do not have permission to access it, the HEAD - request returns a generic 404 Not Found or 403 Forbidden - code. A message body is not included, so you cannot determine the exception beyond - these error codes. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This action is useful to determine if a bucket exists and you have permission to access - it. The action returns a 200 OK if the bucket exists and you have permission - to access it. - - - - If the bucket does not exist or you do not have permission to access it, the HEAD - request returns a generic 404 Not Found or 403 Forbidden - code. A message body is not included, so you cannot determine the exception beyond - these error codes. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to ListBucketIntelligentTieringConfigurations include: - - - - - Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method. - - The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3. - REST API Reference for ListBucketIntelligentTieringConfigurations Operation - - - - Lists the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to ListBucketIntelligentTieringConfigurations include: - - - - - Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3. - REST API Reference for ListBucketIntelligentTieringConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket with each request. You - can use the request parameters as selection criteria to return a subset of the objects - in a bucket. A 200 OK response can contain valid or invalid XML. Make - sure to design your application to parse the contents of the response and handle it - appropriately. Objects are returned sorted in an ascending order of the respective - key names in the list. For more information about listing objects, see Listing - object keys programmatically - - - - To use this operation, you must have READ access to the bucket. - - - - To use this action in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of this action. We recommend that you use - this revised API for application development. For backward compatibility, Amazon S3 - continues to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket with each request. You - can use the request parameters as selection criteria to return a subset of the objects - in a bucket. A 200 OK response can contain valid or invalid XML. Make - sure to design your application to parse the contents of the response and handle it - appropriately. Objects are returned sorted in an ascending order of the respective - key names in the list. For more information about listing objects, see Listing - object keys programmatically - - - - To use this operation, you must have READ access to the bucket. - - - - To use this action in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of this action. We recommend that you use - this revised API for application development. For backward compatibility, Amazon S3 - continues to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration - action returns the transfer acceleration state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration - action returns the transfer acceleration state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. - For more information about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. - For more information about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This action replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will - not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following action is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This action replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will - not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following action is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Creates or modifies OwnershipControls for an Amazon S3 bucket. To use - this operation, you must have the s3:PutBucketOwnershipControls permission. - For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to PutBucketOwnershipControls: - - - - Container for the necessary parameters to execute the PutBucketOwnershipControls service method. - - The response from the PutBucketOwnershipControls service method, as returned by S3. - REST API Reference for PutBucketOwnershipControls Operation - - - - Creates or modifies OwnershipControls for an Amazon S3 bucket. To use - this operation, you must have the s3:PutBucketOwnershipControls permission. - For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to PutBucketOwnershipControls: - - - - Container for the necessary parameters to execute the PutBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketOwnershipControls service method, as returned by S3. - REST API Reference for PutBucketOwnershipControls Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 User Guide. - - - - To perform this operation, the user or role performing the action must have the iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket or buckets where you want Amazon S3 - to replicate objects, the IAM role that Amazon S3 can assume to replicate objects - on your behalf, and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - If you are using an earlier version of the replication configuration, Amazon S3 handles - replication of delete markers differently. For more information, see Backward - Compatibility. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see List - of replication-related error codes - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 User Guide. - - - - To perform this operation, the user or role performing the action must have the iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket or buckets where you want Amazon S3 - to replicate objects, the IAM role that Amazon S3 can assume to replicate objects - on your behalf, and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - If you are using an earlier version of the replication configuration, Amazon S3 handles - replication of delete markers differently. For more information, see Backward - Compatibility. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see List - of replication-related error codes - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - Applies a Legal Hold configuration to the specified object. For more information, - see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectLegalHold service method. - - The response from the PutObjectLegalHold service method, as returned by S3. - REST API Reference for PutObjectLegalHold Operation - - - - Applies a Legal Hold configuration to the specified object. For more information, - see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectLegalHold service method, as returned by S3. - REST API Reference for PutObjectLegalHold Operation - - - - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. For more information, see Locking - Objects. - -
  • - - The DefaultRetention settings require both a mode and a period. - -
  • - - The DefaultRetention period can be either Days or Years - but you must select one. You cannot specify Days and Years - at the same time. - -
  • - - You can only enable Object Lock for new buckets. If you want to turn on Object Lock - for an existing bucket, contact AWS Support. - -
- - Container for the necessary parameters to execute the PutObjectLockConfiguration service method. - - The response from the PutObjectLockConfiguration service method, as returned by S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. For more information, see Locking - Objects. - -
  • - - The DefaultRetention settings require both a mode and a period. - -
  • - - The DefaultRetention period can be either Days or Years - but you must select one. You cannot specify Days and Years - at the same time. - -
  • - - You can only enable Object Lock for new buckets. If you want to turn on Object Lock - for an existing bucket, contact AWS Support. - -
- - Container for the necessary parameters to execute the PutObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectLockConfiguration service method, as returned by S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - Places an Object Retention configuration on an object. For more information, see Locking Objects. - - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectRetention service method. - - The response from the PutObjectRetention service method, as returned by S3. - REST API Reference for PutObjectRetention Operation - - - - Places an Object Retention configuration on an object. For more information, see Locking Objects. - - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectRetention service method, as returned by S3. - REST API Reference for PutObjectRetention Operation - - - - - - - - - - - - - - - - - - - - - - Passes transformed objects to a GetObject operation when using Object - Lambda Access Points. For information about Object Lambda Access Points, see Transforming - objects with Object Lambda Access Points in the Amazon S3 User Guide. - - - - This operation supports metadata that can be returned by GetObject, - in addition to RequestRoute, RequestToken, StatusCode, - ErrorCode, and ErrorMessage. The GetObject - response metadata is supported so that the WriteGetObjectResponse caller, - typically an AWS Lambda function, can provide the same metadata when it internally - invokes GetObject. When WriteGetObjectResponse is called - by a customer-owned Lambda function, the metadata returned to the end user GetObject - call might differ from what Amazon S3 would normally return. - - - - AWS provides some prebuilt Lambda functions that you can use with S3 Object Lambda - to detect and redact personally identifiable information (PII) and decompress S3 objects. - These Lambda functions are available in the AWS Serverless Application Repository, - and can be selected through the AWS Management Console when you create your Object - Lambda Access Point. - - - - Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically detects personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically redacts personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped - to decompress objects stored in S3 in one of six compressed file formats including - bzip2, gzip, snappy, zlib, zstandard and ZIP. - - - - For information on how to view and use these functions, see Using - AWS built Lambda functions in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the WriteGetObjectResponse service method. - - The response from the WriteGetObjectResponse service method, as returned by S3. - REST API Reference for WriteGetObjectResponse Operation - - - - Passes transformed objects to a GetObject operation when using Object - Lambda Access Points. For information about Object Lambda Access Points, see Transforming - objects with Object Lambda Access Points in the Amazon S3 User Guide. - - - - This operation supports metadata that can be returned by GetObject, - in addition to RequestRoute, RequestToken, StatusCode, - ErrorCode, and ErrorMessage. The GetObject - response metadata is supported so that the WriteGetObjectResponse caller, - typically an AWS Lambda function, can provide the same metadata when it internally - invokes GetObject. When WriteGetObjectResponse is called - by a customer-owned Lambda function, the metadata returned to the end user GetObject - call might differ from what Amazon S3 would normally return. - - - - AWS provides some prebuilt Lambda functions that you can use with S3 Object Lambda - to detect and redact personally identifiable information (PII) and decompress S3 objects. - These Lambda functions are available in the AWS Serverless Application Repository, - and can be selected through the AWS Management Console when you create your Object - Lambda Access Point. - - - - Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically detects personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically redacts personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped - to decompress objects stored in S3 in one of six compressed file formats including - bzip2, gzip, snappy, zlib, zstandard and ZIP. - - - - For information on how to view and use these functions, see Using - AWS built Lambda functions in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the WriteGetObjectResponse service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the WriteGetObjectResponse service method, as returned by S3. - REST API Reference for WriteGetObjectResponse Operation - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Constructs a new instance of the AmazonS3Exception class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - Attempt to parse the resource component of the ARN into outpost resource with outpost id and access point name. - - An AWS ARN to parse - True if the ARN contains an outpost access point resource identifier. - - - - Checks whether an ARN belongs to a particular service - - True if a match is found - - - - Parse an Arn to extract information on S3 outpost access point - and if it is not found or properly formatted, throw an exception - - - - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Paginators for the service - - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this action to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This action concatenates the parts that you provide in the - list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - CompleteMultipartUpload has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this action to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This action concatenates the parts that you provide in the - list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - CompleteMultipartUpload has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - - Deletes the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to DeleteBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method. - - The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation - - - - Deletes the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to DeleteBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Removes OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:PutBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to DeleteBucketOwnershipControls: - - - - Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method. - - The response from the DeleteBucketOwnershipControls service method, as returned by S3. - REST API Reference for DeleteBucketOwnershipControls Operation - - - - Removes OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:PutBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to DeleteBucketOwnershipControls: - - - - Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketOwnershipControls service method, as returned by S3. - REST API Reference for DeleteBucketOwnershipControls Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE action uses the policy subresource to delete the - policy of a specified bucket. If you are using an identity other than the root user - of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 User Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 User Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This action removes the website configuration for a bucket. Amazon S3 returns a 200 - OK response upon successfully deleting a website configuration on the specified - bucket. You will get a 200 OK response if the website configuration you - are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE action requires the S3:DeleteBucketWebsite permission. By - default, only the bucket owner can delete the website configuration attached to a - bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This action enables you to delete multiple objects from a bucket using a single HTTP - request. If you know the object keys that you want to delete, then this action provides - a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete action and returns the result of that delete, success, or failure, - in the response. Note that if the object specified in the request is not found, Amazon - S3 returns the result as deleted. - - - - The action supports two modes for the response: verbose and quiet. By default, the - action uses verbose mode in which the response includes the result of deletion of - each key in your request. In quiet mode the response includes only keys where the - delete action encountered an error. For a successful deletion, the action does not - return any information about the delete in the response body. - - - - When performing this action on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - This action enables you to delete multiple objects from a bucket using a single HTTP - request. If you know the object keys that you want to delete, then this action provides - a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete action and returns the result of that delete, success, or failure, - in the response. Note that if the object specified in the request is not found, Amazon - S3 returns the result as deleted. - - - - The action supports two modes for the response: verbose and quiet. By default, the - action uses verbose mode in which the response includes the result of deletion of - each key in your request. In quiet mode the response includes only keys where the - delete action encountered an error. For a successful deletion, the action does not - return any information about the delete in the response body. - - - - When performing this action on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. If the bucket - does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError. - - - - - For information about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. If the bucket - does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError. - - - - - For information about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Gets the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to GetBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method. - - The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for GetBucketIntelligentTieringConfiguration Operation - - - - Gets the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to GetBucketIntelligentTieringConfiguration include: - - - - - Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3. - REST API Reference for GetBucketIntelligentTieringConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - The name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - The name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following action is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:GetBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to GetBucketOwnershipControls: - - - - Container for the necessary parameters to execute the GetBucketOwnershipControls service method. - - The response from the GetBucketOwnershipControls service method, as returned by S3. - REST API Reference for GetBucketOwnershipControls Operation - - - - Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, - you must have the s3:GetBucketOwnershipControls permission. For more - information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to GetBucketOwnershipControls: - - - - Container for the necessary parameters to execute the GetBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketOwnershipControls service method, as returned by S3. - REST API Reference for GetBucketOwnershipControls Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following action is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET action requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are using a previous version of the lifecycle configuration, it still works. - For the earlier action, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object in your - bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following action is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object in your - bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following action is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Using - BitTorrent with Amazon S3. - - - - You can get torrent only for objects that are less than 5 GB in size, and that are - not encrypted using server-side encryption with a customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following action is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to ListBucketIntelligentTieringConfigurations include: - - - - - Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method. - - The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3. - REST API Reference for ListBucketIntelligentTieringConfigurations Operation - - - - Lists the S3 Intelligent-Tiering configuration from the specified bucket. - - - - The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - automatically moving data to the most cost-effective storage access tier, without - additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings - by moving data between access tiers, when access patterns change. - - - - The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB - that you plan to store for at least 30 days. If the size of an object is less than - 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they - are always charged at the frequent access tier rates in the S3 Intelligent-Tiering - storage class. - - - - If you delete an object before the end of the 30-day minimum storage duration period, - you are charged for 30 days. For more information, see Storage - class for automatically optimizing frequently and infrequently accessed objects. - - - - Operations related to ListBucketIntelligentTieringConfigurations include: - - - - - Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3. - REST API Reference for ListBucketIntelligentTieringConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This action supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket with each request. You - can use the request parameters as selection criteria to return a subset of the objects - in a bucket. A 200 OK response can contain valid or invalid XML. Make - sure to design your application to parse the contents of the response and handle it - appropriately. Objects are returned sorted in an ascending order of the respective - key names in the list. For more information about listing objects, see Listing - object keys programmatically - - - - To use this operation, you must have READ access to the bucket. - - - - To use this action in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of this action. We recommend that you use - this revised API for application development. For backward compatibility, Amazon S3 - continues to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket with each request. You - can use the request parameters as selection criteria to return a subset of the objects - in a bucket. A 200 OK response can contain valid or invalid XML. Make - sure to design your application to parse the contents of the response and handle it - appropriately. Objects are returned sorted in an ascending order of the respective - key names in the list. For more information about listing objects, see Listing - object keys programmatically - - - - To use this operation, you must have READ access to the bucket. - - - - To use this action in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of this action. We recommend that you use - this revised API for application development. For backward compatibility, Amazon S3 - continues to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all versions of the objects in a bucket. You can also use request - parameters as selection criteria to return metadata about a subset of all the object - versions. - - - - To use this operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - This action is not supported by Amazon S3 on Outposts. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration - action returns the transfer acceleration state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration - action returns the transfer acceleration state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. - For more information about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. - For more information about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This action replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will - not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following action is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This action replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will - not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following action is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Creates or modifies OwnershipControls for an Amazon S3 bucket. To use - this operation, you must have the s3:PutBucketOwnershipControls permission. - For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to PutBucketOwnershipControls: - - - - Container for the necessary parameters to execute the PutBucketOwnershipControls service method. - - The response from the PutBucketOwnershipControls service method, as returned by S3. - REST API Reference for PutBucketOwnershipControls Operation - - - - Creates or modifies OwnershipControls for an Amazon S3 bucket. To use - this operation, you must have the s3:PutBucketOwnershipControls permission. - For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For information about Amazon S3 Object Ownership, see Using - Object Ownership. - - - - The following operations are related to PutBucketOwnershipControls: - - - - Container for the necessary parameters to execute the PutBucketOwnershipControls service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketOwnershipControls service method, as returned by S3. - REST API Reference for PutBucketOwnershipControls Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 User Guide. - - - - To perform this operation, the user or role performing the action must have the iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket or buckets where you want Amazon S3 - to replicate objects, the IAM role that Amazon S3 can assume to replicate objects - on your behalf, and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - If you are using an earlier version of the replication configuration, Amazon S3 handles - replication of delete markers differently. For more information, see Backward - Compatibility. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see List - of replication-related error codes - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 User Guide. - - - - To perform this operation, the user or role performing the action must have the iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket or buckets where you want Amazon S3 - to replicate objects, the IAM role that Amazon S3 can assume to replicate objects - on your behalf, and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - If you are using an earlier version of the replication configuration, Amazon S3 handles - replication of delete markers differently. For more information, see Backward - Compatibility. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see List - of replication-related error codes - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - When this operation sets the tags for a bucket, it will overwrite any current tags - the bucket already has. You cannot use this operation to add tags to an existing list - of tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional action is currently in progress against this - resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT action requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - Applies a Legal Hold configuration to the specified object. For more information, - see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectLegalHold service method. - - The response from the PutObjectLegalHold service method, as returned by S3. - REST API Reference for PutObjectLegalHold Operation - - - - Applies a Legal Hold configuration to the specified object. For more information, - see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectLegalHold service method, as returned by S3. - REST API Reference for PutObjectLegalHold Operation - - - - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. For more information, see Locking - Objects. - -
  • - - The DefaultRetention settings require both a mode and a period. - -
  • - - The DefaultRetention period can be either Days or Years - but you must select one. You cannot specify Days and Years - at the same time. - -
  • - - You can only enable Object Lock for new buckets. If you want to turn on Object Lock - for an existing bucket, contact AWS Support. - -
- - Container for the necessary parameters to execute the PutObjectLockConfiguration service method. - - The response from the PutObjectLockConfiguration service method, as returned by S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. For more information, see Locking - Objects. - -
  • - - The DefaultRetention settings require both a mode and a period. - -
  • - - The DefaultRetention period can be either Days or Years - but you must select one. You cannot specify Days and Years - at the same time. - -
  • - - You can only enable Object Lock for new buckets. If you want to turn on Object Lock - for an existing bucket, contact AWS Support. - -
- - Container for the necessary parameters to execute the PutObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectLockConfiguration service method, as returned by S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - Places an Object Retention configuration on an object. For more information, see Locking Objects. - - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectRetention service method. - - The response from the PutObjectRetention service method, as returned by S3. - REST API Reference for PutObjectRetention Operation - - - - Places an Object Retention configuration on an object. For more information, see Locking Objects. - - - - - This action is not supported by Amazon S3 on Outposts. - - - Container for the necessary parameters to execute the PutObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutObjectRetention service method, as returned by S3. - REST API Reference for PutObjectRetention Operation - - - - - - - - - - - - - - - - - - - - - - Passes transformed objects to a GetObject operation when using Object - Lambda Access Points. For information about Object Lambda Access Points, see Transforming - objects with Object Lambda Access Points in the Amazon S3 User Guide. - - - - This operation supports metadata that can be returned by GetObject, - in addition to RequestRoute, RequestToken, StatusCode, - ErrorCode, and ErrorMessage. The GetObject - response metadata is supported so that the WriteGetObjectResponse caller, - typically an AWS Lambda function, can provide the same metadata when it internally - invokes GetObject. When WriteGetObjectResponse is called - by a customer-owned Lambda function, the metadata returned to the end user GetObject - call might differ from what Amazon S3 would normally return. - - - - AWS provides some prebuilt Lambda functions that you can use with S3 Object Lambda - to detect and redact personally identifiable information (PII) and decompress S3 objects. - These Lambda functions are available in the AWS Serverless Application Repository, - and can be selected through the AWS Management Console when you create your Object - Lambda Access Point. - - - - Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically detects personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically redacts personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped - to decompress objects stored in S3 in one of six compressed file formats including - bzip2, gzip, snappy, zlib, zstandard and ZIP. - - - - For information on how to view and use these functions, see Using - AWS built Lambda functions in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the WriteGetObjectResponse service method. - - The response from the WriteGetObjectResponse service method, as returned by S3. - REST API Reference for WriteGetObjectResponse Operation - - - - Passes transformed objects to a GetObject operation when using Object - Lambda Access Points. For information about Object Lambda Access Points, see Transforming - objects with Object Lambda Access Points in the Amazon S3 User Guide. - - - - This operation supports metadata that can be returned by GetObject, - in addition to RequestRoute, RequestToken, StatusCode, - ErrorCode, and ErrorMessage. The GetObject - response metadata is supported so that the WriteGetObjectResponse caller, - typically an AWS Lambda function, can provide the same metadata when it internally - invokes GetObject. When WriteGetObjectResponse is called - by a customer-owned Lambda function, the metadata returned to the end user GetObject - call might differ from what Amazon S3 would normally return. - - - - AWS provides some prebuilt Lambda functions that you can use with S3 Object Lambda - to detect and redact personally identifiable information (PII) and decompress S3 objects. - These Lambda functions are available in the AWS Serverless Application Repository, - and can be selected through the AWS Management Console when you create your Object - Lambda Access Point. - - - - Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically detects personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - language processing (NLP) service using machine learning to find insights and relationships - in text. It automatically redacts personally identifiable information (PII) such as - names, addresses, dates, credit card numbers, and social security numbers from documents - in your Amazon S3 bucket. - - - - Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped - to decompress objects stored in S3 in one of six compressed file formats including - bzip2, gzip, snappy, zlib, zstandard and ZIP. - - - - For information on how to view and use these functions, see Using - AWS built Lambda functions in the Amazon S3 User Guide. - - - Container for the necessary parameters to execute the WriteGetObjectResponse service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the WriteGetObjectResponse service method, as returned by S3. - REST API Reference for WriteGetObjectResponse Operation - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Validates S3ObjectLambda Access Points. - - - - - Validates Outposts Access points. - - - - - Checks the validity of a Fips configuration for Access Point and Object Lambda - (NOT OUTPOST - fips isn't supported in outpost) - - - Valid Fips Config: true - No Fips Config: false - Invalid Fips Config: exception - - - Thrown if an invalid Fips configuration is found. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Shared helper methods for S3 ARNs - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Container for the parameters to the AbortMultipartUpload operation. - This action aborts a multipart upload. After a multipart upload is aborted, no additional - parts can be uploaded using that upload ID. The storage consumed by any previously - uploaded parts will be freed. However, if any part uploads are currently in progress, - those part uploads might or might not succeed. As a result, it might be necessary - to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts - action and ensure that the parts list is empty. - - - - For information about permissions required to use the multipart upload, see Multipart - Upload and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - - - - Gets and sets the property BucketName. - - The bucket name to which the upload was taking place. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property UploadId. - - Upload ID that identifies the multipart upload. - - - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - A container for information about access control for replicas. - - - - - Gets and sets the property Owner. - - Specifies the replica ownership. For default and valid values, see PUT - bucket replication in the Amazon S3 API Reference. - - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - The identifier used to represent an analytics configuration. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Intelligent Tiering Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Intelligent-Tiering Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete Bucket IntelligentTieringConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketIntelligentTiering operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket OwenershipControls Request Marshaller - - - - - Response Unmarshaller for DeleteBucketOwnershipControls operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetBucketIntelligentTieringConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - GetBucketOwnershipControls Request Marshaller - - - - - Response Unmarshaller for GetBucketOwnershipControls operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - Unmarshaller for IntelligentTieringConfiguration - - - - - IntelligentTieringFilter Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - Request Marshaller for ListBucketIntelligentTieringConfigurations - - - - - Response Unmarshaller for ListBucketIntelligentTieringConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Put Bucket IntelligentTieringConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketIntelligentTieringConfiguration operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - PutBucketOwnershipControls Request Marshaller - - - - - Response Unmarshaller for PutBucketOwnershipControls operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Unmarshaller for ReplicaModifications - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - SSES3 Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - Tiering Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The file format used when exporting data to Amazon S3. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the property BucketKeyEnabled. - - Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption - with AWS KMS (SSE-KMS). - - - - - - Gets and sets the property BucketName. - - The name of the bucket that contains the newly created object. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ETag. - - Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. The - entity tag may or may not be an MD5 digest of the object data. If the entity tag is - not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters - and/or will consist of less than 32 or more than 32 hexadecimal digits. - - - - - - Gets and sets the property Expiration. - - If the object expiration is configured, this will contain the expiration date (expiry-date) - and rule ID (rule-id). The value of rule-id is URL encoded. - - - - - - Gets and sets the property Key. - - The object key of the newly created object. - - - - - - Gets and sets the property Location. - - The URI that identifies the newly created object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Gets and sets the property VersionId. - - Version ID of the newly created object, in case the bucket has versioning turned on. - - - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic action using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy action starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete list - of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Server-side encryption - - - - When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with AWS managed encryption - keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, - Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts - the data when you access it. For more information about server-side encryption, see - Using - Server-Side Encryption. - - - - If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject action to change the storage class of an object - that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see RestoreObject. - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - This action is not supported by Amazon S3 on Outposts. - - - - - Gets and sets the property BucketKeyEnabled. - - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with - server-side encryption using AWS KMS (SSE-KMS). Setting this header to true - causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. - - - - Specifying this header with a COPY action doesn't affect bucket-level settings for - S3 Bucket Key. - - - - - - This is a convenience property for Headers.ContentType. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The name of the destination bucket. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. - For more information about access point ARNs, see - Using Access Points in the Amazon Simple Storage Service Developer Guide. - When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. - The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. - For more information about S3 on Outposts ARNs, see - Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected destination bucket owner. If the destination bucket - is owned by a different account, the request will fail with an HTTP 403 (Access - Denied) error. - - - - - - Gets and sets the property ExpectedSourceBucketOwner. - - The account ID of the expected source bucket owner. If the source bucket is owned - by a different account, the request will fail with an HTTP 403 (Access Denied) - error. - - - - - - Checks to see if ExpectedSourceBucketOwner is set. - - true, if ExpectedSourceBucketOwner property is set. - - - - The collection of meta data for the request. - - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Gets and sets the property SSEKMSEncryptionContext. - - Specifies the AWS KMS Encryption Context to use for object encryption. The value of - this header is a base64-encoded UTF-8 string holding JSON with the encryption context - key-value pairs. - - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Gets and sets the property SSEKMSKeyId. - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests - for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For - information about configuring using any of the officially supported AWS SDKs and AWS - CLI, see Specifying - the Signature Version in Request Authentication in the Amazon S3 User Guide. - - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Gets and sets the property StorageClass. - - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. - The STANDARD storage class provides high durability and high availability. Depending - on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts - only uses the OUTPOSTS Storage Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - The collection of headers for the request. - - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyObject response and response metadata. - - - - - Indicates whether the copied object uses bucket key for server-side - encryption with AWS KMS (SSE-KMS). - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Version ID of the newly created copy. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. - For more information about access point ARNs, see - Using Access Points in the Amazon Simple Storage Service Developer Guide. - When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. - The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. - For more information about S3 on Outposts ARNs, see - Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The account ID of the expected destination bucket owner. - If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The account ID of the expected source bucket owner. - If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedSourceBucketOwner is set. - - true, if ExpectedSourceBucketOwner property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Indicates whether the multipart upload uses bucket key - for server-side encryption with AWS KMS (SSE-KMS). - - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - -

Unique identifier for the rule. The value cannot be longer than 255 characters.

- - - The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. - - - - - The ID used to identify the S3 Intelligent-Tiering configuration. - - - - - Returns information about the DeleteBucketIntelligentTieringConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketOwnershipControlsRequest operation. - - - - - The Amazon S3 bucket whose OwnershipControls you want to delete. - - - - - The account ID of the expected bucket owner. If the bucket is owned by a different account, - the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketOwnershipControls response metadata. - The DeleteBucketOwnershipControls operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Container for the parameters to the DeleteBucketReplication operation. - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 User Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - - - - Gets and sets the property BucketName. - Deletes the replication subresource associated with the specified bucket. - There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems. - For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - - Specifies whether Amazon S3 replicates delete markers. - If you specify a Filter in your replication configuration, - you must also include a DeleteMarkerReplication element. - If your Filter includes a Tag element, - the DeleteMarkerReplication Status must be set to Disabled, - because Amazon S3 does not support replicating delete markers for tag-based rules. - For an example configuration, - see Basic Rule Configuration. - For more information about delete marker replication, see Basic Rule Configuration. - If you are using an earlier version of the replication configuration, - Amazon S3 handles replication of delete markers differently. For more information, - see Backward Compatibility. - - - - - Indicates whether to replicate delete markers. - - - - - Container for the parameters to the DeleteObject operation. - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects but will still respond that the command was successful. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling DELETE Object or configure its lifecycle - (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or accounts - from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, - s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration - actions. - - - - The following action is related to DeleteObject: - - - - - - - Gets and sets the property BucketName. - - The bucket name of the bucket containing the object. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property BypassGovernanceRetention. - - Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process - this operation. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property VersionId. - - VersionId used to reference a specific version of the object. - - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This action enables you to delete multiple objects from a bucket using a single HTTP - request. If you know the object keys that you want to delete, then this action provides - a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete action and returns the result of that delete, success, or failure, - in the response. Note that if the object specified in the request is not found, Amazon - S3 returns the result as deleted. - - - - The action supports two modes for the response: verbose and quiet. By default, the - action uses verbose mode in which the response includes the result of deletion of - each key in your request. In quiet mode the response includes only keys where the - delete action encountered an error. For a successful deletion, the action does not - return any information about the delete in the response body. - - - - When performing this action on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - Gets and sets the property BucketName. - - The bucket name containing the objects to delete. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - List of object keys to delete. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Sets the with information about DeleteObjectsResponse - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - - Sets the with information about the DeleteObjectsResponse. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Container for the parameters to the DeleteObjectTagging operation. - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - - - - Gets and sets the property BucketName. - - The bucket name containing the objects from which to remove the tags. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - Gets and sets the property VersionId. - - The versionId of the object that the tag-set will be removed from. - - - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - Specifies encryption-related information for an Amazon S3 bucket that is a destination - for replicated objects. - - - - - Gets and sets the property ReplicaKmsKeyID. - - Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored - in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this - key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed - KMS keys. For more information, see Using - symmetric and asymmetric keys in the AWS Key Management Service Developer Guide. - - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - Constructs a new instance of the S3EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Optional configuration to replicate existing source bucket objects. For more information, - see Replicating - Existing Objects in the Amazon S3 User Guide. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation with an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket for which the accelerate configuration is retrieved. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. - - - - - The ID used to identify the S3 Intelligent-Tiering configuration. - - - - - Container for S3 Intelligent-Tiering configuration. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - The name of the bucket for which to get the notification configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketOwnershipControls operation. - - - - - The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve - - - - -

The account ID of the expected bucket owner. If the bucket is owned by a different account, - the request will fail with an HTTP 403 (Access Denied) error.

- - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketOwnershipControls response and response metadata. - - - - - The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in effect for this Amazon S3 bucket - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object whose Legal Hold status you want to retrieve. - - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the GetObjectMetadata operation. - The HEAD action retrieves metadata from an object without returning the object itself. - This action is useful if you're only interested in an object's metadata. To use HEAD, - you must have READ access to the object. - - - - A HEAD request has the same options as a GET action on an - object. The response is identical to the GET response except that there - is no response body. Because of this, if the HEAD request generates an - error, it returns a generic 404 Not Found or 403 Forbidden - code. It is not possible to retrieve the exact exception beyond these error codes. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - -
  • - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - -
  • - - The last modified property in this case is the creation date of the object. - -
- - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following action is related to HeadObject: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket containing the object. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - -

Amazon S3 can return this header if your request involves a - bucket that is either a source or a destination in a replication rule.

In replication, - you have a source bucket on which you configure replication and destination bucket or buckets - where Amazon S3 stores object replicas. When you request an object (GetObject) or - object metadata (HeadObject) from these buckets, Amazon S3 will - return the x-amz-replication-status header in the response as follows:

-

  • If requesting an object from the source bucket — Amazon S3 will return the - x-amz-replication-status header if the object in your request is eligible for - replication.

    For example, suppose that in your replication configuration, you specify - object prefix TaxDocs requesting Amazon S3 to replicate objects with key - prefix TaxDocs. Any objects you upload with this key name prefix, for example - TaxDocs/document1.pdf, are eligible for replication. For any object request with - this key name prefix, Amazon S3 will return the x-amz-replication-status header - with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If - requesting an object from a destination bucket — Amazon S3 will return the - x-amz-replication-status header with value REPLICA if the object in your - request is a replica that Amazon S3 created.

  • When replicating objects - to multiple destination buckets the x-amz-replication-status header acts differently. - The header of the source object will only return a value of COMPLETED when replication is - successful to all destinations. The header will remain at value PENDING until replication has - completed for all destinations. If one or more destinations fails replication the header will - return FAILED.

For more information, - see Replication.

- - - - - The archive state of the head object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates whether the object uses bucket key for - server-side encryption with AWS KMS (SSE-KMS). - - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive - storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - tiers, before you can retrieve the object you must first restore a copy using RestoreObject. - Otherwise, this action returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side-encryption-customer-algorithm - -
  • - - x-amz-server-side-encryption-customer-key - -
  • - - x-amz-server-side-encryption-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET action returns the current version of an object. To return a different - version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - VersionId used to reference a specific version of the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - Indicates whether the object uses bucket key - for server-side encryption with AWS KMS (SSE-KMS). - - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. For more information, see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object whose retention settings you want to retrieve. - - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTagging operation. - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object in your - bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following action is related to GetObjectTagging: - - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object for which to get the tagging information. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Gets and sets the property Key. - - Object key for which to get the tagging information. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that they will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Gets and sets the property VersionId. - - The versionId of the object for which to get the tagging information. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This action is useful to determine if a bucket exists and you have permission to access - it. The action returns a 200 OK if the bucket exists and you have permission - to access it. - - - - If the bucket does not exist or you do not have permission to access it, the HEAD - request returns a generic 404 Not Found or 403 Forbidden - code. A message body is not included, so you cannot determine the exception beyond - these error codes. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - - - Gets and sets the property BucketName. - - The bucket name. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - This action initiates a multipart upload and returns an upload ID. This upload ID - is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort action and - Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart - and UploadPartCopy - requests must match the headers you used in the request to initiate the upload by - using CreateMultipartUpload. - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Decrypt and kms:GenerateDataKey* - actions on the key. These permissions are required because Amazon S3 must decrypt - and read data from the encrypted file parts before it completes the multipart upload. - For more information, see Multipart - upload API and permissions in the Amazon S3 User Guide. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side-encryption-customer-algorithm - -
    • - - x-amz-server-side-encryption-customer-key - -
    • - - x-amz-server-side-encryption-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - This action is not supported by Amazon S3 on Outposts. - - - - - Gets and sets the property BucketKeyEnabled. - - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with - server-side encryption using AWS KMS (SSE-KMS). Setting this header to true - causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. - - - - Specifying this header with an object action doesn't affect bucket-level settings - for S3 Bucket Key. - - - - - - Gets and sets the property BucketName. - - The name of the bucket to which to initiate the upload - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - This is a convenience property for Headers.ContentType. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The collection of meta data for the request. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Gets and sets the property StorageClass. - - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. - The STANDARD storage class provides high durability and high availability. Depending - on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts - only uses the OUTPOSTS Storage Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Gets and sets the property WebsiteRedirectLocation. - - If the bucket is configured as a website, redirects requests for this object to another - object in the same bucket or to an external URL. Amazon S3 stores the value of this - header in the object metadata. - - - - - - The collection of headers for the request. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Gets and sets the property AbortDate. - - If the bucket has a lifecycle rule configured with an action to abort incomplete multipart - uploads and the prefix in the lifecycle rule matches the object name in the request, - the response includes this header. The header indicates when the initiated multipart - upload becomes eligible for an abort operation. For more information, see - Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - The response also includes the x-amz-abort-rule-id header that provides - the ID of the lifecycle configuration rule that defines this action. - - - - - - Gets and sets the property AbortRuleId. - - This header is returned along with the x-amz-abort-date header. It identifies - the applicable lifecycle configuration rule that defines the action to abort incomplete - multipart uploads. - - - - - - Gets and sets the property BucketKeyEnabled. - - Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption - with AWS KMS (SSE-KMS). - - - - - - Gets and sets the property BucketName. - - The name of the bucket to which the multipart upload was initiated. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property Key. - - Object key for which the multipart upload was initiated. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Gets and sets the property UploadId. - - ID for the initiated multipart upload. - - - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for specifying S3 Intelligent-Tiering filters. - The filters determine the subset of objects to which the rule applies. - - - - - Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket. - For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects. - - - - - The ID used to identify the S3 Intelligent-Tiering configuration. - - - - - Specifies a bucket filter. - The configuration only includes objects that meet the filter's criteria. - - - - - Specifies the status of the configuration. - - - - - Specifies the S3 Intelligent-Tiering storage class tier of the configuration. - - - - - The Filter is used to identify objects that the - S3 Intelligent-Tiering configuration applies to. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - An object key name prefix that identifies the subset of objects to which the configuration applies. - - - - - All of these tags must exist in the object's tag set in order for the configuration to apply. - - - - - Specifies the inventory configuration for an Amazon S3 bucket. For more information, - see GET - Bucket inventory in the Amazon S3 API Reference. - - - - - Gets and sets the property Destination. - - Contains information about where to publish the inventory results. - - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Gets and sets the property IncludedObjectVersions. - - Object versions to include in the inventory list. If set to All, the - list includes all the object versions, which adds the version-related fields VersionId, - IsLatest, and DeleteMarker to the list. If set to Current, - the list does not contain these version-related fields. - - - - - - Gets and sets the property IsEnabled. - - Specifies whether the inventory is enabled or disabled. If set to True, - an inventory list is generated. If set to False, no inventory list is - generated. - - - - - - Contains the optional fields that are included in the inventory results. - - - - - Gets and sets the property Schedule. - - Specifies the schedule for generating inventory results. - - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put - Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, - see Put - Bucket Lifecycle Configuration Examples. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently - deletes the noncurrent object versions. You set this lifecycle configuration action - on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete - noncurrent object versions at a specific period in the object's lifetime. - - - - - Gets and sets the property NoncurrentDays. - - Specifies the number of days an object is noncurrent before Amazon S3 can perform - the associated action. For information about the noncurrent days calculations, see - How - Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User - Guide. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - The list of S3 Intelligent-Tiering configurations for a bucket. - - - - - Check to see if IntelligentTieringConfiguration property is set - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the - NextContinuationToken will be provided for a subsequent request. - - - - - The marker used to continue this inventory configuration listing. - Use the NextContinuationToken from this response to - continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This action lists in-progress multipart uploads. An in-progress multipart upload is - a multipart upload that has been initiated using the Initiate Multipart Upload request, - but has not yet been completed or aborted. - - - - This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket to which the multipart upload was initiated. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property Delimiter. - - Character you use to group keys. - - - - All keys that contain the same string between the prefix, if specified, and the first - occurrence of the delimiter after the prefix are grouped under a single result element, - CommonPrefixes. If you don't specify the prefix parameter, then the substring - starts at the beginning of the key. The keys that are grouped under CommonPrefixes - result element are not returned elsewhere in the response. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Gets and sets the property KeyMarker. - - Together with upload-id-marker, this parameter specifies the multipart upload after - which listing should begin. - - - - If upload-id-marker is not specified, only the keys lexicographically - greater than the specified key-marker will be included in the list. - - - - If upload-id-marker is specified, any multipart uploads for a key equal - to the key-marker might also be included, provided those multipart uploads - have upload IDs lexicographically greater than the specified upload-id-marker. - - - - - - Gets and sets the property MaxUploads. - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response - body. 1,000 is the maximum number of uploads that can be returned in a response. - - - - - - Gets and sets the property Prefix. - - Lists in-progress uploads only for those keys that begin with the specified prefix. - You can use prefixes to separate a bucket into different grouping of keys. (You can - think of using prefix to make groups in the same way you'd use a folder in a file - system.) - - - - - - Gets and sets the property UploadIdMarker. - - Together with key-marker, specifies the multipart upload after which listing should - begin. If key-marker is not specified, the upload-id-marker parameter is ignored. - Otherwise, any multipart uploads for a key equal to the key-marker might be included - in the list only if they have an upload ID lexicographically greater than the specified - upload-id-marker. - - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - The name of the bucket to which the multipart upload was initiated. - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This action has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket containing the objects. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - A delimiter is a character you use to group keys. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Gets and sets the property MaxKeys. - - Sets the maximum number of keys returned in the response. By default the action returns - up to 1,000 key names. The response might contain fewer keys but will never contain - more. - - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Gets and sets the property RequestPayer. - - Confirms that the requester knows that she or he will be charged for the list objects - request. Bucket owners need not specify this parameter in their requests. - - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - The bucket name. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjectsV2 operation. - Returns some or all (up to 1,000) of the objects in a bucket with each request. You - can use the request parameters as selection criteria to return a subset of the objects - in a bucket. A 200 OK response can contain valid or invalid XML. Make - sure to design your application to parse the contents of the response and handle it - appropriately. Objects are returned sorted in an ascending order of the respective - key names in the list. For more information about listing objects, see Listing - object keys programmatically - - - - To use this operation, you must have READ access to the bucket. - - - - To use this action in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of this action. We recommend that you use - this revised API for application development. For backward compatibility, Amazon S3 - continues to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - - - - Gets and sets the property BucketName. - - Bucket name to list. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ContinuationToken. - - ContinuationToken indicates Amazon S3 that the list is being continued on this bucket - with a token. ContinuationToken is obfuscated and is not a real key. - - - - - - A delimiter is a character you use to group keys. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Gets and sets the property MaxKeys. - - Sets the maximum number of keys returned in the response. By default the action returns - up to 1,000 key names. The response might contain fewer keys but will never contain - more. - - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Gets and sets the property RequestPayer. - - Confirms that the requester knows that she or he will be charged for the list objects - request in V2 style. Bucket owners need not specify this parameter in their requests. - - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property StartAfter. - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing - after this specified key. StartAfter can be any key in the bucket. - - - - - - Returns information about the ListObjects response and response metadata. - - - - - Gets and sets the property CommonPrefixes. - - All of the keys (up to 1,000) rolled up into a common prefix count as a single return - when calculating the number of returns. - - - - A response can contain CommonPrefixes only if you specify a delimiter. - - - - CommonPrefixes contains all (if there are any) keys between Prefix - and the next occurrence of the string specified by a delimiter. - - - - CommonPrefixes lists keys that act like subdirectories in the directory - specified by Prefix. - - - - For example, if the prefix is notes/ and the delimiter is a slash (/) - as in notes/summer/july, the common prefix is notes/summer/. - All of the keys that roll up into a common prefix count as a single return when calculating - the number of returns. - - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - Gets and sets the property Delimiter. - - Causes keys that contain the same string between the prefix and the first occurrence - of the delimiter to be rolled up into a single result element in the CommonPrefixes - collection. These rolled-up keys are not returned elsewhere in the response. Each - rolled-up result counts as only one return against the MaxKeys value. - - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - Encoding type used by Amazon S3 to encode object key names in the XML response. - - - - If you specify the encoding-type request parameter, Amazon S3 includes this element - in the response, and returns encoded key name values in the following response elements: - - - - Delimiter, Prefix, Key, and StartAfter. - - - - - - Gets and sets the property IsTruncated. - - Set to false if all of the results were returned. Set to true if more keys are available - to return. If the number of results exceeds that specified by MaxKeys, all of the - results might not be returned. - - - - - - Gets and sets the property KeyCount. - - KeyCount is the number of keys returned with this request. KeyCount will always be - less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include - less than equals 50 keys - - - - - - Gets and sets the property MaxKeys. - - Sets the maximum number of keys returned in the response. By default the action returns - up to 1,000 key names. The response might contain fewer keys but will never contain - more. - - - - - - Gets and sets the property Name. - - The bucket name. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property NextContinuationToken. - - NextContinuationToken is sent when isTruncated is true, - which means there are more keys in the bucket that can be listed. The next list requests - to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken - is obfuscated and is not a real key - - - - - - Gets and sets the property Prefix. - - Keys that begin with the indicated prefix. - - - - - - Gets and sets the property StartAfter. - - If StartAfter was sent with the request, it is included in the response. - - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number of parts - returned is 1,000 parts. You can restrict the number of parts returned by specifying - the max-parts request parameter. If your multipart upload consists of - more than 1,000 parts, the response returns an IsTruncated field with - the value of true, and a NextPartNumberMarker element. In subsequent - ListParts requests you can include the part-number-marker query string - parameter and set its value to the NextPartNumberMarker field value from - the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload and Permissions. - - - - The following operations are related to ListParts: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket to which the parts are being uploaded. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property MaxParts. - - Sets the maximum number of parts to return. - - - - - - Gets and sets the property PartNumberMarker. - - Specifies the part after which listing should begin. Only parts with higher part numbers - will be listed. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property UploadId. - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Returns information about the ListParts response and response metadata. - - - - - The name of the bucket to which the multipart upload was initiated. - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - The bucket name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying settings for configuring replication metrics and events. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Specifies a metrics configuration for the CloudWatch request metrics (specified by - the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing - metrics configuration, note that this is a full replacement of the existing metrics - configuration. If you don't include the elements you want to keep, they are erased. - For more information, see - PUT Bucket metrics in the Amazon S3 API Reference. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - The ID used to identify the metrics configuration. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - The container element for a bucket's ownership controls - - - - - A bucket's ownership control rules - - - - - The container element for an ownership control rule - - - - - The object ownership for a bucket's ownership controls - - - - - Checks whether the ObjectOwnership property is set - - True if the ObjectOwnership property is set - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - Setting this element to TRUE restricts access to this bucket to only AWS - service principals and authorized users within this account if the bucket has a - public policy. Enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, - including non-public delegation to specific accounts, is blocked. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The canned ACL to apply to the bucket. - - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation with an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. - For more information about access point ARNs, see - Using Access Points in the Amazon Simple Storage Service Developer Guide. - When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. - The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. - For more information about S3 on Outposts ARNs, see - Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket for which the accelerate configuration is set. - - - - - Accelerate configuration for the bucket. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. - - - - - The ID used to identify the S3 Intelligent-Tiering configuration. - - - - - Container for S3 Intelligent-Tiering configuration. - - - - - Returns information about the PutBucketIntelligentTieringConfiguration response metadata. - The PutBucketIntelligentTieringConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketOwnershipControls operation. - - - - - The name of the Amazon S3 bucket whose OwnershipControls you want to set - - - - -

The account ID of the expected bucket owner. If the bucket is owned by a different account, - the request will fail with an HTTP 403 (Access Denied) error.

- - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want to apply to this Amazon S3 bucket - - - - - Returns information about the PutBucketOwnershipControls response metadata. - The PutBucketOwnershipControls operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 User Guide. - - - - To perform this operation, the user or role performing the action must have the iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket or buckets where you want Amazon S3 - to replicate objects, the IAM role that Amazon S3 can assume to replicate objects - on your behalf, and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - If you are using an earlier version of the replication configuration, Amazon S3 handles - replication of delete markers differently. For more information, see Backward - Compatibility. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see List - of replication-related error codes - - - - The following operations are related to PutBucketReplication: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - A token to allow Object Lock to be enabled for an existing bucket. - - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and - have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never - allowed to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information about bucket naming - restrictions, see Bucket - naming rules. - - - - If you want to create an Amazon S3 on Outposts bucket, see Create - Bucket. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see Accessing - a bucket. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - hosting of buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - control list (ACL) overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - your storage lifecycle. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - - - - Gets and sets the property BucketName. - - The name of the bucket for which to set the configuration. - - - - - - The lifecycle configuration to be applied. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. For more information, - see Locking - Objects. - - - - This action is not supported by Amazon S3 on Outposts. - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object that you want to place a Legal Hold on. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash for the request body. - - - - For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field - is calculated automatically. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Gets and sets the property BucketKeyEnabled. - - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with - server-side encryption using AWS KMS (SSE-KMS). Setting this header to true - causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. - - - - Specifying this header with a PUT action doesn't affect bucket-level settings for - S3 Bucket Key. - - - - - - Gets and sets the property BucketName. - - The bucket name to which the PUT action was initiated. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - This is a convenience property for Headers.ContentType. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The collection of meta data for the request. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether a legal hold will be applied to this object. For more information - about S3 Object Lock, see Object - Lock. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Gets and sets the property StorageClass. - - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. - The STANDARD storage class provides high durability and high availability. Depending - on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts - only uses the OUTPOSTS Storage Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Gets and sets the property WebsiteRedirectLocation. - - If the bucket is configured as a website, redirects requests for this object to another - object in the same bucket or to an external URL. Amazon S3 stores the value of this - header in the object metadata. For information about object metadata, see Object - Key and Metadata. - - - - In the following example, the request header sets the redirect to an object (anotherPage.html) - in the same bucket: - - - - x-amz-website-redirect-location: /anotherPage.html - - - - In the following example, the request header sets the object redirect to another website: - - - - x-amz-website-redirect-location: http://www.example.com/ - - - - For more information about website hosting in Amazon S3, see Hosting - Websites on Amazon S3 and How - to Configure Website Page Redirects. - - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - WARNING: Setting DisableMD5Stream to true disables the MD5 data integrity check - on this request. - When true, MD5Stream will not be used in the upload request. This may increase - upload performance under high CPU loads. The default value is null. When null, the - AWSConfigsS3.DisableMD5Stream property value will be used. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing - data integrity check on this request. - If using SigV4, the DisablePayloadSigning flag controls if the payload should be - signed on a request by request basis. By default this flag is null which will use the - default client behavior. The default client behavior is to sign the payload. When - DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. - Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS - connection. - Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may - be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies - to Amazon S3 PutObject and UploadPart requests. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - The collection of headers for the request. - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Gets or sets whether the Content-MD5 header should be calculated for upload. - - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the PutObject response and response metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates whether the uploaded object uses bucket key for server-side encryption with AWS KMS (SSE-KMS). - - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. For more information, see Locking Objects. - - - - - This action is not supported by Amazon S3 on Outposts. - - - - - - Gets and sets the property BucketName. - - The bucket name that contains the object you want to apply this Object Retention configuration - to. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - - - Gets and sets the property BypassGovernanceRetention. - - Indicates whether this action should bypass Governance-mode restrictions. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash for the request body. - - - - For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field - is calculated automatically. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Check to see if Bucket property is set - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - Confirms that the requester knows that they will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - Gets and sets the property VersionId. - - The versionId of the object that the tag-set will be added to. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - A filter that you can specify for selection for modifications on replicas. - Amazon S3 doesn't replicate replica modifications by default. In the latest version - of replication configuration (when Filter is specified), you can specify - this element and set the status to Enabled to replicate modifications on - replicas. If you don't specify the Filter element, Amazon S3 - assumes that the replication configuration is the earlier version, V1. In the earlier version, - this element is not allowed. - - - - - Specifies whether Amazon S3 replicates modifications on replicas. - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Specifies information about where to publish analysis or configuration results for - an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). - - - - - Gets and sets the property AccessControlTranslation. - - Specify this only in a cross-account scenario (where source and destination bucket - owners are not the same), and you want to change replica ownership to the AWS account - that owns the destination bucket. If this is not specified in the replication configuration, - the replicas are owned by same AWS account that owns the source object. - - - - - - Gets and sets the property AccountId. - - Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon - S3 to change replica ownership to the AWS account that owns the destination bucket - by specifying the AccessControlTranslation property, this is the account - ID of the destination bucket owner. For more information, see Replication - Additional Configuration: Changing the Replica Owner in the Amazon S3 User - Guide. - - - - - - Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule. - If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket. - - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - Gets and sets the property EncryptionConfiguration. - - A container that provides information about encryption. If SourceSelectionCriteria - is specified, you must specify this element. - - - - - - Gets and sets the property Metrics. - - A container specifying replication metrics-related settings enabling replication - metrics and events. - - - - - - Gets and sets the property ReplicationTime. - - A container specifying S3 Replication Time Control (S3 RTC), including whether S3 - RTC is enabled and the time when all objects and operations on objects must be replicated. - Must be specified together with a Metrics block. - - - - - - Gets and sets the property StorageClass. - - The storage class to use when replicating objects, such as S3 Standard or reduced - redundancy. By default, Amazon S3 uses the storage class of the source object to create - the object replica. - - - - For valid values, see the StorageClass element of the PUT - Bucket replication action in the Amazon S3 API Reference. - - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - - The priority indicates which rule has priority when there is a conflict. - Amazon S3 will attempt to replicate objects according to all replication rules. - However, if objects are replicating to the same destination bucket priority will - decide which object will attempt to replicate first. The higher the number, the - higher the priority. For more information, - see Replication in - the Amazon Simple Storage Service Developer Guide. - - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - - Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects. if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys. - - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Container for specifying a tag key and value. - The rule applies only to objects having the tag in its tagset. - - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - - Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:
  • - You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.
    • -
  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.
- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - - Gets and sets the property BucketName. - - The bucket name containing the object to restore. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Lifetime of the active copy in days. - Do not use with restores that specify OutputLocation. - The Days element is required for regular restores, and must not be provided for - select requests. - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The optional description for the job. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Tier at which the restore will be processed. - - - - - Retrieval tier at which the restore will be processed. - - - - - Type of restore request. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - For more information about routing rules, see https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects\ - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy. - - - - - The name of the bucket. - - - - - - Describes where logs are stored and the prefix that Amazon S3 assigns to all log object - keys for a bucket. For more information, see PUT - Bucket logging in the Amazon S3 API Reference. - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - Gets and sets the property TargetPrefix. - - A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets - in a single bucket, you can use a prefix to distinguish which log files came from - which bucket. - - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - Describes the versioning state of an Amazon S3 bucket. For more information, see PUT - Bucket versioning in the Amazon S3 API Reference. - - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - The account ID of the expected bucket owner. - If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - Describes the default server-side encryption to apply to new objects in the bucket. - If a PUT Object request doesn't specify any server-side encryption, this default encryption - will be applied. For more information, see PUT - Bucket encryption in the Amazon S3 API Reference. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. - This parameter is allowed if and only if ServerSideEncryptionAlgorithm is set to aws:kms. - - - - You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, - if you are using encryption with cross-account operations, you must use a fully qualified - KMS key ARN. For more information, see Using - encryption for cross-account operations. - - - - For example: - -
  • - - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - -
  • - - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - - -
- - Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, - see Using - symmetric and asymmetric keys in the AWS Key Management Service Developer Guide. - - - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - Specifies whether Amazon S3 should use bucket key with - server-side encryption using KMS (SSE-KMS) for new objects in the bucket. - Existing objects are not affected. Setting the BucketKeyEnabled - element to true causes Amazon S3 to use bucket key. By default, - bucket key is not enabled. For more information, - see Bucket key in - the Amazon Simple Storage Service Developer Guide.", - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - A filter that you can specify for selections for modifications on replicas. - Amazon S3 doesn't replicate replica modifications by default. In the - latest version of replication configuration (when Filter is specified), you can - specify this element and set the status to Enabled to replicate modifications on - replicas. If you don't specify the Filter element, - Amazon S3 assumes that the replication configuration is the earlier version, V1. - In the earlier version, this element is not allowed - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - A container for filter information for the selection of S3 objects encrypted with - AWS KMS. - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the object key. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - The S3 Intelligent-Tiering storage class is designed to - optimize storage costs by automatically moving data to the most - cost-effective storage access tier, without additional operational overhead. - - - - - The number of consecutive days of no access after which an object - will be eligible to be transitioned to the corresponding tier. The minimum number of - days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier - must be at least 180 days. The maximum can be up to 2 years (730 days). - - - - - S3 Intelligent-Tiering access tier. - See - Storage class for automatically optimizing frequently and infrequently accessed objects - for a list of access tiers in the S3 Intelligent-Tiering storage class. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - Gets and sets the property BucketName. - - The name of the bucket to which the multipart upload was initiated. - - - - When using this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the AWS SDKs, you provide the - access point ARN in place of the bucket name. For more information about access point - ARNs, see Using - access points in the Amazon S3 User Guide. - - - - When using this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action using S3 on Outposts through the AWS SDKs, you provide the - Outposts bucket ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see Using - S3 on Outposts in the Amazon S3 User Guide. - - - - - - Gets and sets the property ExpectedBucketOwner. - - The account ID of the expected bucket owner. If the bucket is owned by a different - account, the request will fail with an HTTP 403 (Access Denied) error. - - - - - - Checks to see if ExpectedBucketOwner is set. - - true, if ExpectedBucketOwner property is set. - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property PartNumber. - - Part number of part being uploaded. This is a positive integer between 1 and 10,000. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - Specifies the algorithm to use to when encrypting the object (for example, AES256). - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - WARNING: Setting DisableMD5Stream to true disables the MD5 data integrity check - on this request. - When true, MD5Stream will not be used in the upload request. This may increase - upload performance under high CPU loads. The default value is null. When null, the - AWSConfigsS3.DisableMD5Stream property value will be used. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - An MD5 digest for the part. - - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing - data integrity check on this request. - If using SigV4, the DisablePayloadSigning flag controls if the payload should be - signed on a request by request basis. By default this flag is null which will use the - default client behavior. The default client behavior is to sign the payload. When - DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. - Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS - connection. - Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may - be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies - to Amazon S3 PutObject and UploadPart requests. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Gets or sets whether the Content-MD5 header should be calculated for upload. - - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates whether the multipart upload uses bucket - key for server-side encryption with AWS KMS (SSE-KMS). - - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The request class for WriteGetObjectReponse operation - - - - - Route prefix to the HTTP URL generated. - - - - - A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request. - - - - - - A string that uniquely identifies an error condition. Returned in <Code> tag of error XML response for corresponding GetObject call. Cannot be used with successful StatusCode header or when transformed object is provided in body. - - - - - Contains a generic description of the error condition. Returned in <Message> tag of error XML response for corresponding GetObject call. Cannot be used with successful StatusCode header or when transformed object is provided in body. - - - - - Indicates that a range of bytes was specified. - - - - - Specifies caching behavior along the request/reply chain. - - - - - Specifies presentational information for the object. - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. - - - - - The language the content is in. - - - - - The size of the body in bytes. - - - - - The portion of the object returned in the response. - - - - - A standard MIME type describing the format of the object data. - - - - - Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. - - - - - The date and time at which the object is no longer cacheable. - - - - - If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded. - - - - - Date and time the object was last modified. - - - - - Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. - - - - - A map of metadata to store with the object in S3. - - - - - - Indicates whether object stored in Amazon S3 has an active legal hold. - - - - - Date and time when Object Lock is configured to expire. - - - - - The count of parts this object has. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Provides information about object restoration operation and expiration time of the restored object copy. - - - - - The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms). - - - - - Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3. - - - - - If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object. - - - - - - The class of storage used to store object in Amazon S3. - - - - - The number of tags, if any, on the object. - - - - - VersionId used to reference a specific version of the object. - - - - - Indicates whether the object stored in Amazon S3 uses a S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). - - - - - The object data. - - - - - Paginator for the ListMultipartUploads operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Uploads - - - - - Enumerable containing all of the CommonPrefixes - - - - - Paginator for the ListObjects operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the S3Objects - - - - - Enumerable containing all of the CommonPrefixes - - - - - Paginator for the ListObjectsV2 operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the S3Objects - - - - - Enumerable containing all of the CommonPrefixes - - - - - Paginator for the ListParts operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Parts - - - - - Paginator for the ListVersions operation - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Versions - - - - - Enumerable containing all of the CommonPrefixes - - - - - Paginators for the S3 service - - - - - Paginator for ListMultipartUploads operation - - - - - - - Paginator for ListObjects operation - - - - - - - Paginator for ListObjectsV2 operation - - - - - - - Paginator for ListParts operation - - - - - - - Paginator for ListVersions operation - - - - - - - Base class for ListMultipartUploads paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Uploads - - - - - Enumerable containing all of the CommonPrefixes - - - - - Base class for ListObjects paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the S3Objects - - - - - Enumerable containing all of the CommonPrefixes - - - - - Base class for ListObjectsV2 paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the S3Objects - - - - - Enumerable containing all of the CommonPrefixes - - - - - Base class for ListParts paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Parts - - - - - Base class for ListVersions paginators. - - - - - Enumerable containing all full responses for the operation - - - - - Enumerable containing all of the Versions - - - - - Enumerable containing all of the CommonPrefixes - - - - - Paginators for the S3 service - - - - - Paginator for ListMultipartUploads operation - - - - - - - Paginator for ListObjects operation - - - - - - - Paginator for ListObjectsV2 operation - - - - - - - Paginator for ListParts operation - - - - - - - Paginator for ListVersions operation - - - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Constructs a new instance of the DeleteObjectsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use ME-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use AF-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - The OUTPOSTS storage class for objects stored in a S3 Outpost - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Constant BucketKeyStatus for InventoryOptionalField - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Specifies who is assigned ownership of objects uploaded to a bucket - - - - - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL - - - - - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL - - - - - Finds the ObjectOwnership instance for the string value - - - - - - - Converts the string to ObjectOwnership instance - - - - - - intelligent tiering is enabled. - - - - - intelligent tiering is disabled. - - - - - Finds the IntelligentTieringStatus instance for the string value - - - - - - - Converts the string to IntelligentTieringStatus instance - - - - - - Access Tier is set to Archive Access. - - - - - Access Tier is set to Deep Archive Access. - - - - - Finds the IntelligentTieringAccessTier instance for the string value - - - - - - - Converts the string to IntelligentTieringAccessTier instance - - - - - - The Archive status associated with this source object. - - - - - The Status is ARCHIVE_ACCESS. - - - - - The Status is DEEP_ARCHIVE_ACCESS. - - - - - Construct instance of ArchiveStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ArchiveStatus. - The ArchiveStatus object for that string. - - - - Convert string to ArchiveStatus. - - - - - - - Replica Modification is enabled. - - - - - Replica Modification is disabled. - - - - - Finds the ReplicaModificationsStatus instance for the string value - - - - - - - Converts the string to ReplicaModificationsStatus instance - - - - - - A resource in an S3 Outpost - - - - - Create a new S3OutpostResource object - - - - - - ID of the S3 Outpost - - - - - Name of the access point bucket - - - - - Key for object in bucket - - - - - The full name of the S3 Outpost Resource - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return null. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets whether the Content-MD5 header should be calculated for upload. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - WARNING: Setting DisableMD5Stream to true disables the MD5 data integrity check - on this request. - When true, MD5Stream will not be used in the upload request. This may increase - upload performance under high CPU loads. The default value is null. When null, the - AWSConfigsS3.DisableMD5Stream property value will be used. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing - data integrity check on this request. - If using SigV4, the DisablePayloadSigning flag controls if the payload should be - signed on a request by request basis. By default this flag is null which will use the - default client behavior. The default client behavior is to sign the payload. When - DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. - Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS - connection. - Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may - be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies - to Amazon S3 PutObject and UploadPart requests. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - Gets or sets whether the Content-MD5 header should be calculated for upload. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - An encoded URI is expected. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - An encoded URI is expected. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the stream specified - - The Stream for which the MD5 Digest needs - to be computed. - A string representation of the hash with base64 encoding - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Check if the request resource is an outpost resource - - The S3 request object - - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The version of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the server side encryption method for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the server side encryption method for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The version of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the redirect location for the S3 Object's when being accessed through the S3 website endpoint. - - The name of the bucket in which the key is stored - The key of the S3 Object - The redirect location - The Amazon S3 Client to use for S3 specific operations. - - - - Sets up the request needed to make an exact copy of the object leaving the parent method - the ability to change just the attribute being requested to change. - - - - - - - - - - - Converts the string representing a storage class that would come back from a ListObjects request - to the S3StorageClass enumeration. - - Amazon S3 string values for storage class - The converted S3StorageClass enumeration - - - - Upload data to Amazon S3 using HTTP POST. - - - For more information, - - Request object which describes the data to POST - Thrown if the service returns an error - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Represents the status of an asynchronous operation. - It adds support for Cancelation of the asynchronous operation. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous - operation to complete. - - - - - Gets a value that indicates whether the asynchronous operation completed - synchronously. - - - - - Gets a value that indicates whether the asynchronous operation has completed. - - - - - Gets a value that indicates whether a cancel is requested. - - - - - The last exception that when the asynchronous operation was executed. - This is used to capture the exception and re-throw it when EndOperation is called. - - - - - The callback to be invoked when the asynchronous operation is completed. - - - - - Constructor for AsyncCancelableResult. - - The callback to be invoked when the asynchronous operation is completed. - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Signals that the operaton is canceled and invokes the callback. - - - - - Signals that the operation is completed and invoked the callback. - - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - Disposes any managed and unmanaged resources. - - Should pass true if called by Dispose(), pass false if - called during finalization. - - - - Represents the status of an asynchronous operation. This interface extends - IAsyncResult and adds support for Cancelation of the asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - An exception detailing a failed HTTP POST upload atempt to Amazon S3. - - - - - Initializes a new instance of S3PostUploadException with a specified error message - - The error message - - - - Initializes a new instance of S3PostUploadException with a specified error code and error message - - The error code - The error message - - - - The error code returned by S3 - - - - - The S3 request id - - - - - The S3 host id - - - - - The HTTP error status code returned by S3 - - - - - Additional information about the error - - - Some errors are accompanied by more specific information, which vary from error to error - - - - - Parse an S3 Error response and create an S3PostUploadException - - The response from S3 - An S3PostUploadException with the information from the response - - - - Constructs a new instance of the S3PostUploadException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class for unmarshalling response XML - - - - - Gets and sets the ErrorCode property. - - - - - Gets and sets the ErrorMessage property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the elements property. - - - - - Parameters for uploading to Amazon S3 a file using HTTP POS - - - - If a S3PostUploadSignedPolicy is assigned, then values set (other than InputStream or Path) on this object must adhere to the policy. - This includes metadata. If metadata is specified in the policy, then it must be included in the request. Adding metadata not in the - policy will cause the POST to fail. - - For more information, - - - - - - Default constructor. - - - - - S3 Bucket to upload the object to - - - - - The name of the uploaded key. - - - - - Stream to read the upload data for - - - If you use InputStream, then you also need to set ContentLength - - - - - File path to read the upload data from - - - - - Content type for the uploaded data - - - If this is not set, an attempt will be made to infer it from the extension on Key or Path (in that order), - otherwise 'application/octet-stream' will be assumed. - - - - - Specifies an Amazon S3 access control list - - - - - Signed policy from bucket owner. - - - - - Where to redirect browsers on a successful upload - - - - - The status code returned to the client upon successful upload if success_action_redirect is not specified - - - - Accepts the values OK (200) , Created (201), or NoContent (204, default). - - If the value is set to OK or NoContent, Amazon S3 returns an empty document with a 200 or 204 status code. - - If the value is set to Created, Amazon S3 returns an XML document with a 201 status code. - - If the value is not set or if it is set to an invalid value, Amazon S3 returns an empty document with a 204 status code. - - - - - - Storage class to use for storing the object - - - Default: STANDARD - - - - - The AWS region where the bucket is located. - - - Depending upon the bucket name, POST uploads will be - successfully redirected, but for buckets with non-DNS-compliant - characters, redirects will fail. Setting this to the appropriate - region will avoid the redirect. - - - - - Metadata to set on the uploaded object - - - If keys do not begin with 'x-amz-meta-' it will be added at POST time. - - - - - Write the multipart/form-data for this request for all fields except the file data to a stream - - - - - Class holds Response data for a post upload. - - - - - Gets and sets the StatusCode property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the CloudFront request ID. - - - - - Utility class for managing and exchanging HTTP POST uploads of objects to Amazon S3. - - - - This object supports creating, marshalling, and unmarshalling of the information needed to build - an authenticated HTTP POST request to S3 for uploading objects according to a policy. - - For more information, - - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - A signed policy object for use with an S3PostUploadRequest. - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - Service region endpoint. - A signed policy object for use with an S3PostUploadRequest. - - - - The policy document which governs what uploads can be done. - - - - - The signature for the policy. - - - - - The AWS Access Key Id for the credential pair that produced the signature. - - - - - The security token from session or instance credentials. - - - - - The signature version usedd. Either "2" or "4". - - - - - The signing algorithm used. Required as a field in the post Amazon - S3 can re-calculate the signature. - - - - - The date value in ISO8601 format. It is the same date used in - creating the signing key. - - - - - In addition to the access key ID, this provides scope information - used in calculating the signing key for signature calculation. - - - - - Get the policy document as a human readable string. - - Human readable policy document. - - - - JSON representation of this object - - JSON string - - - - XML Representation of this object - - XML String - - - - Create an instance of this class from a JSON string. - - JSON string - Instance of S3PostUploadSignedPolicy - - - - Create an instance of this class from an XML string. - - XML string generated by ToXml() - Instance of S3PostUploadSignedPolicy - - - - Mimics the System.IO.DirectoryInfo for a virtual directory in S3. It exposes properties and methods for enumerating directories and files as well as - methods manipulate directories. - - - It is important to keep in mind that S3 is not a filesystem. It is possible for S3 object keys to contain - characters which are not not legal file path characters, and so some pre-existing objects in a bucket that were created with - other software may not be compatible with this class. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - The S3DirectoryInfo for the root of the S3 bucket. - - - - - Checks with S3 to see if the directory exists and if so returns true. - - Due to Amazon S3's eventual consistency model this property can return false for newly created buckets. - - - - - - - Returns empty string for directories. - - - - - The full path of the directory including bucket name. - - - - - Returns the last write time of the the latest file written to the directory. - - - - - - - UTC converted version of LastWriteTime. - - - - - - - Returns the name of the folder. - - - - - Return the S3DirectoryInfo of the parent directory. - - - - - Returns the S3DirectroyInfo for the S3 account. - - - - - Returns the type of file system element. - - - - - Creates the directory in S3. If no object key was specified when creating the S3DirectoryInfo then the bucket will be created. - - - - - - - Creates a sub directory inside the instance of S3DirectoryInfo. - - - - - - - - - Deletes all the files in this directory as well as this directory. - - - - - - - - Deletes all the files in this directory as well as this directory. If recursive is set to true then all sub directories will be - deleted as well. - - - - - If true then sub directories will be deleted as well. - - - - Enumerate the sub directories of this directory. - - - - An enumerable collection of directories. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - - - An enumerable collection of directories that matches searchPattern. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of directories that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Returns the S3DirectoryInfo for the specified sub directory. - - Directory to get the S3DirectroyInfo for. - The S3DirectoryInfo for the specified sub directory. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - - - An array of directories. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all files. - An array of files that matches searchPattern. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of directories that matches searchPattern and searchOption. - - - - Returns the S3FileInfo for the specified file. - - File to get the S3FileInfo for. - The S3FileInfo for the specified file. - - - - Returns an array of S3FileInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. - - The target bucket to copy to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. Only - files that have changed since the changeSince date will be copied. - - The target bucket to copy to. - The target object key which represents a directory in S3. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. Only - files that have changed since the changeSince date will be copied. - - The target directory to copy to. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to copy the files to. - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - Only files that have been modified since the changesSince property will be copied. - - The location on the local file system to copy the files to. - Date which files must have changed since in ordered to be copied. - - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - - The local file system path where the files are to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - Only files that have been modified since the changesSince property will be copied. - - The local file system path where the files are to copy. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Moves the directory to the target directory specified by the bucket and object key. - - The target bucket to move to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Moves the directory to the target S3 directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Moves the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the files to. - - - - DirectoryInfo for the local directory where files are moved to. - - - - Moves files from the local file system to S3 in this directory. Sub directories are moved as well. - - The local file system path where the files are to be moved. - - - - S3DirectoryInfo where the files are moved to. - - - - Implement the ToString method. - - - - - - Creating and deleting buckets can sometimes take a little bit of time. To make sure - users of this API do not experience the side effects of the eventual consistency - we block until the state change has happened. - - - - - - Mimics the System.IO.FileInfo for a file in S3. It exposes properties and methods manipulating files in S3. - - - - - Initialize a new instance of the S3FileInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - Returns the parent S3DirectoryInfo. - - - - - The full name of parent directory. - - - - - Checks S3 if the file exists in S3 and return true if it does. - - - - - - - Gets the file's extension. - - - - - Returns the full path including the bucket. - - - - - Returns the last time the file was modified. - - - - - - - Returns the last time the file was modified in UTC. - - - - - - - Returns the content length of the file. - - - - - - - Returns the file name without its directory name. - - - - - Returns the type of file system element. - - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - - - - S3FileInfo of the newly copied file. - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 than an ArgumentException is thrown. - - Target directory where to copy the file to. - If the directory does not exist. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Target directory where to copy the file to. - Determines whether the file can be overwritten. - If the directory does not exist. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 than an ArgumentException is thrown. - - The target location to copy this file to. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The target location to copy this file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system than an ArgumentException is thrown. - - The path where to copy the file to. - If the file already exists locally. - - - FileInfo for the local file where file is copied to. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown. - - The path where to copy the file to. - Determines whether the file can be overwritten. - If the file already exists locally and overwrite is set to false. - - - FileInfo for the local file where file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - If the file already exists in S3. - - - S3FileInfo where the file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo where the file is copied to. - - - - Returns a Stream that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Returns a StreamWriter that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Deletes the from S3. - - - - - - - Moves the file to a a new location in S3. - - Bucket to move the file to. - Object key to move the file to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target directory to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target file to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file from S3 to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the file to. - If the file already exists locally. - - - - FileInfo for the local file where file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - If the file already exists locally. - - - - S3FileInfo where the file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo where the file is moved to. - - - - Returns a Stream for reading the contents of the file. - - The file is already open. - - - Stream to read from. - - - - Returns a StreamReader for reading the contents of the file. - - The file is already open. - - - StreamReader to read from. - - - - Returns a Stream for writing to S3. If the file already exists it will be overwritten. - - - The content will not be written to S3 until the Stream is closed. - - The file is already open. - - - Stream to write from. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backup location is specifed then the content of destination file is - backup to it. - - Destination bucket of this file will be copy to. - Destination object key of this file will be copy to. - Backup bucket to store the contents of the destination file. - Backup object key to store the contents of the destination file. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupDir is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupFile is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the content of the destination file on the local file system with the content from this file from S3. - If a backup file is specified then the content of the destination file is backup to it. - - - - - - - - - - - - Implement the ToString method. - - - - - - Enumeration indicated whether a file system element is a file or directory. - - - - - Type is a directory. - - - - - Type is a file. - - - - - Common interface for both S3FileInfo and S3DirectoryInfo. - - - - - Returns true if the item exists in S3. - - - - - Returns the extension of the item. - - - - - Returns the fully qualified path to the item. - - - - - Returns the last modified time for this item from S3 in local timezone. - - - - - Returns the last modified time for this item from S3 in UTC timezone. - - - - - Returns the name of the item without parent information. - - - - - Indicates what type of item this object represents. - - - - - Deletes this item from S3. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - WARNING: Setting DisableMD5Stream to true disables the MD5 data integrity check - on upload requests. - When true, MD5Stream will not be used in upload requests. This may increase upload - performance under high CPU loads. The default value is false. Set this value to true to - disable MD5Stream use in all S3 upload requests or override this value per request by - setting the DisableMD5Stream property on PutObjectRequest, UploadPartRequest, or - TransferUtilityUploadRequest. - MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity - verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the - possibility of data corruption is completely dependant on HTTPS being the only remaining - source of data integrity verification. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - - V4-enabling section - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml.meta deleted file mode 100644 index aaf7bccc..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.S3.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 215c02bbf31315d45b0234c41acec5bf -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.dll.meta deleted file mode 100644 index 1f882f74..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 607a3e03feb30694f972732cc1b72394 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml deleted file mode 100644 index 3b89a2d5..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml +++ /dev/null @@ -1,8940 +0,0 @@ - - - - AWSSDK.SecurityToken - - - - - Implementation for accessing SecurityTokenService - - AWS Security Token Service - - AWS Security Token Service (STS) enables you to request temporary, limited-privilege - credentials for AWS Identity and Access Management (IAM) users or for users that you - authenticate (federated users). This guide provides descriptions of the STS API. For - more information about using this service, see Temporary - Security Credentials. - - - - - - - - The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - Immutable AssumeRoleCredentials - - - - - - The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - Immutable AssumeRoleCredentials - - - - - - - - - - - - - Customizes the runtime pipeline by replacing the default retry handler with a custom one that retries certain STS errors. - - The client runtime pipeline - - - - Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonSecurityTokenServiceClient Configuration Object - - - - Constructs AmazonSecurityTokenServiceClient with AWS Credentials - - AWS Credentials - - - - Constructs AmazonSecurityTokenServiceClient with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonSecurityTokenServiceClient with AWS Credentials and an - AmazonSecurityTokenServiceClient Configuration object. - - AWS Credentials - The AmazonSecurityTokenServiceClient Configuration Object - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an - AmazonSecurityTokenServiceClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonSecurityTokenServiceClient Configuration Object - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an - AmazonSecurityTokenServiceClient Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonSecurityTokenServiceClient Configuration Object - - - - Creates the signer for the service. - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - Returns a set of temporary security credentials that you can use to access AWS resources - that you might not normally have access to. These temporary credentials consist of - an access key ID, a secret access key, and a security token. Typically, you use AssumeRole - within your account or for cross-account access. For a comparison of AssumeRole - with other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRole can be used - to make API calls to any AWS service with the following exception: You cannot call - the AWS STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - To assume a role from a different account, your AWS account must be trusted by the - role. The trust relationship is defined in the role's trust policy when the role is - created. That trust policy states which accounts are allowed to delegate that access - to users in the account. - - - - A user who wants to access a role in a different account must also have permissions - that are delegated from the user account administrator. The administrator must attach - a policy that allows the user to call AssumeRole for the ARN of the role - in the other account. If the user is in the same account as the role, then you can - do either of the following: - -
  • - - Attach a policy to the user (identical to the previous user in a different account). - -
  • - - Add the user as a principal directly in the role's trust policy. - -
- - In this case, the trust policy acts as an IAM resource-based policy. Users in the - same account as the role do not need explicit permission to assume the role. For more - information about trust policies and resource-based policies, see IAM - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These tags are called - session tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Using MFA with AssumeRole - - - - (Optional) You can include multi-factor authentication (MFA) information when you - call AssumeRole. This is useful for cross-account scenarios to ensure - that the user that assumes the role has been authenticated with an AWS MFA device. - In that scenario, the trust policy of the role being assumed includes a condition - that tests for MFA authentication. If the caller does not include valid MFA information, - the request to assume the role is denied. The condition in a trust policy that tests - for MFA authentication might look like the following example. - - - - "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} - - - - For more information, see Configuring - MFA-Protected API Access in the IAM User Guide guide. - - - - To use MFA with AssumeRole, you pass values for the SerialNumber - and TokenCode parameters. The SerialNumber value identifies - the user's hardware or virtual MFA device. The TokenCode is the time-based - one-time password (TOTP) that the MFA device produces. - - - Container for the necessary parameters to execute the AssumeRole service method. - - The response from the AssumeRole service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRole Operation - - - - Returns a set of temporary security credentials that you can use to access AWS resources - that you might not normally have access to. These temporary credentials consist of - an access key ID, a secret access key, and a security token. Typically, you use AssumeRole - within your account or for cross-account access. For a comparison of AssumeRole - with other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRole can be used - to make API calls to any AWS service with the following exception: You cannot call - the AWS STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - To assume a role from a different account, your AWS account must be trusted by the - role. The trust relationship is defined in the role's trust policy when the role is - created. That trust policy states which accounts are allowed to delegate that access - to users in the account. - - - - A user who wants to access a role in a different account must also have permissions - that are delegated from the user account administrator. The administrator must attach - a policy that allows the user to call AssumeRole for the ARN of the role - in the other account. If the user is in the same account as the role, then you can - do either of the following: - -
  • - - Attach a policy to the user (identical to the previous user in a different account). - -
  • - - Add the user as a principal directly in the role's trust policy. - -
- - In this case, the trust policy acts as an IAM resource-based policy. Users in the - same account as the role do not need explicit permission to assume the role. For more - information about trust policies and resource-based policies, see IAM - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These tags are called - session tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Using MFA with AssumeRole - - - - (Optional) You can include multi-factor authentication (MFA) information when you - call AssumeRole. This is useful for cross-account scenarios to ensure - that the user that assumes the role has been authenticated with an AWS MFA device. - In that scenario, the trust policy of the role being assumed includes a condition - that tests for MFA authentication. If the caller does not include valid MFA information, - the request to assume the role is denied. The condition in a trust policy that tests - for MFA authentication might look like the following example. - - - - "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} - - - - For more information, see Configuring - MFA-Protected API Access in the IAM User Guide guide. - - - - To use MFA with AssumeRole, you pass values for the SerialNumber - and TokenCode parameters. The SerialNumber value identifies - the user's hardware or virtual MFA device. The TokenCode is the time-based - one-time password (TOTP) that the MFA device produces. - - - Container for the necessary parameters to execute the AssumeRole service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRole service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRole Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - via a SAML authentication response. This operation provides a mechanism for tying - an enterprise identity store or directory to role-based AWS access without user-specific - credentials or configuration. For a comparison of AssumeRoleWithSAML - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this operation consist of an access - key ID, a secret access key, and a security token. Applications can use these temporary - security credentials to sign calls to AWS services. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithSAML - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. Your role session lasts for the - duration that you specify, or until the time specified in the SAML authentication - response's SessionNotOnOrAfter value, whichever is shorter. You can provide - a DurationSeconds value from 900 seconds (15 minutes) up to the maximum - session duration setting for the role. This setting can have a value from 1 hour to - 12 hours. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Role - chaining limits your AWS CLI or AWS API role session to a maximum of one hour. - When you use the AssumeRole API operation to assume a role, you can specify - the duration of your role session with the DurationSeconds parameter. - You can specify a parameter value of up to 43200 seconds (12 hours), depending on - the maximum session duration setting for your role. However, if you assume a role - using role chaining and provide a DurationSeconds parameter value greater - than one hour, the operation fails. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithSAML can - be used to make API calls to any AWS service with the following exception: you cannot - call the STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Calling AssumeRoleWithSAML does not require the use of AWS security credentials. - The identity of the caller is validated by using keys in the metadata document that - is uploaded for the SAML provider entity for your identity provider. - - - - Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail - logs. The entry includes the value in the NameID element of the SAML - assertion. We recommend that you use a NameIDType that is not associated - with any personally identifiable information (PII). For example, you could instead - use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your SAML assertion - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, session tags override the role's tags with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - SAML Configuration - - - - Before your application can call AssumeRoleWithSAML, you must configure - your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, - you must use AWS Identity and Access Management (IAM) to create a SAML provider entity - in your AWS account that represents your identity provider. You must also create an - IAM role that specifies this SAML provider in its trust policy. - - - - For more information, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithSAML service method. - - The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithSAML Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - via a SAML authentication response. This operation provides a mechanism for tying - an enterprise identity store or directory to role-based AWS access without user-specific - credentials or configuration. For a comparison of AssumeRoleWithSAML - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this operation consist of an access - key ID, a secret access key, and a security token. Applications can use these temporary - security credentials to sign calls to AWS services. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithSAML - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. Your role session lasts for the - duration that you specify, or until the time specified in the SAML authentication - response's SessionNotOnOrAfter value, whichever is shorter. You can provide - a DurationSeconds value from 900 seconds (15 minutes) up to the maximum - session duration setting for the role. This setting can have a value from 1 hour to - 12 hours. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Role - chaining limits your AWS CLI or AWS API role session to a maximum of one hour. - When you use the AssumeRole API operation to assume a role, you can specify - the duration of your role session with the DurationSeconds parameter. - You can specify a parameter value of up to 43200 seconds (12 hours), depending on - the maximum session duration setting for your role. However, if you assume a role - using role chaining and provide a DurationSeconds parameter value greater - than one hour, the operation fails. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithSAML can - be used to make API calls to any AWS service with the following exception: you cannot - call the STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Calling AssumeRoleWithSAML does not require the use of AWS security credentials. - The identity of the caller is validated by using keys in the metadata document that - is uploaded for the SAML provider entity for your identity provider. - - - - Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail - logs. The entry includes the value in the NameID element of the SAML - assertion. We recommend that you use a NameIDType that is not associated - with any personally identifiable information (PII). For example, you could instead - use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your SAML assertion - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, session tags override the role's tags with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - SAML Configuration - - - - Before your application can call AssumeRoleWithSAML, you must configure - your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, - you must use AWS Identity and Access Management (IAM) to create a SAML provider entity - in your AWS account that represents your identity provider. You must also create an - IAM role that specifies this SAML provider in its trust policy. - - - - For more information, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithSAML service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithSAML Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - in a mobile or web application with a web identity provider. Example providers include - Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible - identity provider. - - - - For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon - Cognito with the AWS SDK for iOS Developer - Guide and the AWS SDK for Android - Developer Guide to uniquely identify a user. You can also supply the user with - a consistent identity throughout the lifetime of an application. - - - - To learn more about Amazon Cognito, see Amazon - Cognito Overview in AWS SDK for Android Developer Guide and Amazon - Cognito Overview in the AWS SDK for iOS Developer Guide. - - - - Calling AssumeRoleWithWebIdentity does not require the use of AWS security - credentials. Therefore, you can distribute an application (for example, on mobile - devices) that requests temporary security credentials without including long-term - AWS credentials in the application. You also don't need to deploy server-based proxy - services that use long-term AWS credentials. Instead, the identity of the caller is - validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this API consist of an access key ID, - a secret access key, and a security token. Applications can use these temporary security - credentials to sign calls to AWS service API operations. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithWebIdentity - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. You can provide a value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. To learn how to view the maximum - value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithWebIdentity - can be used to make API calls to any AWS service with the following exception: you - cannot call the STS GetFederationToken or GetSessionToken - API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your web identity token - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, the session tag overrides the role tag with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Identities - - - - Before your application can call AssumeRoleWithWebIdentity, you must - have an identity token from a supported identity provider and create a role that the - application can assume. The role that your application assumes must trust the identity - provider that is associated with the identity token. In other words, the identity - provider must be specified in the role's trust policy. - - - - Calling AssumeRoleWithWebIdentity can result in an entry in your AWS - CloudTrail logs. The entry includes the Subject - of the provided web identity token. We recommend that you avoid using any personally - identifiable information (PII) in this field. For example, you could instead use a - GUID or a pairwise identifier, as suggested - in the OIDC specification. - - - - For more information about how to use web identity federation and the AssumeRoleWithWebIdentity - API, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method. - - The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request could not be fulfilled because the identity provider (IDP) that was asked - to verify the incoming identity token could not be reached. This is often a transient - error caused by network conditions. Retry the request a limited number of times so - that you don't exceed the request rate. If the error persists, the identity provider - might be down or not responding. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithWebIdentity Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - in a mobile or web application with a web identity provider. Example providers include - Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible - identity provider. - - - - For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon - Cognito with the AWS SDK for iOS Developer - Guide and the AWS SDK for Android - Developer Guide to uniquely identify a user. You can also supply the user with - a consistent identity throughout the lifetime of an application. - - - - To learn more about Amazon Cognito, see Amazon - Cognito Overview in AWS SDK for Android Developer Guide and Amazon - Cognito Overview in the AWS SDK for iOS Developer Guide. - - - - Calling AssumeRoleWithWebIdentity does not require the use of AWS security - credentials. Therefore, you can distribute an application (for example, on mobile - devices) that requests temporary security credentials without including long-term - AWS credentials in the application. You also don't need to deploy server-based proxy - services that use long-term AWS credentials. Instead, the identity of the caller is - validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this API consist of an access key ID, - a secret access key, and a security token. Applications can use these temporary security - credentials to sign calls to AWS service API operations. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithWebIdentity - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. You can provide a value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. To learn how to view the maximum - value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithWebIdentity - can be used to make API calls to any AWS service with the following exception: you - cannot call the STS GetFederationToken or GetSessionToken - API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your web identity token - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, the session tag overrides the role tag with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Identities - - - - Before your application can call AssumeRoleWithWebIdentity, you must - have an identity token from a supported identity provider and create a role that the - application can assume. The role that your application assumes must trust the identity - provider that is associated with the identity token. In other words, the identity - provider must be specified in the role's trust policy. - - - - Calling AssumeRoleWithWebIdentity can result in an entry in your AWS - CloudTrail logs. The entry includes the Subject - of the provided web identity token. We recommend that you avoid using any personally - identifiable information (PII) in this field. For example, you could instead use a - GUID or a pairwise identifier, as suggested - in the OIDC specification. - - - - For more information about how to use web identity federation and the AssumeRoleWithWebIdentity - API, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request could not be fulfilled because the identity provider (IDP) that was asked - to verify the incoming identity token could not be reached. This is often a transient - error caused by network conditions. Retry the request a limited number of times so - that you don't exceed the request rate. If the error persists, the identity provider - might be down or not responding. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithWebIdentity Operation - - - - Decodes additional information about the authorization status of a request from an - encoded message returned in response to an AWS request. - - - - For example, if a user is not authorized to perform an operation that he or she has - requested, the request returns a Client.UnauthorizedOperation response - (an HTTP 403 response). Some AWS operations additionally return an encoded message - that can provide details about this authorization failure. - - - - Only certain AWS operations return an encoded authorization message. The documentation - for an individual operation indicates whether that operation returns an encoded message - in addition to returning an HTTP code. - - - - The message is encoded because the details of the authorization status can constitute - privileged information that the user who requested the operation should not see. To - decode an authorization status message, a user must be granted permissions via an - IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) - action. - - - - The decoded message includes the following type of information: - -
  • - - Whether the request was denied due to an explicit deny or due to the absence of an - explicit allow. For more information, see Determining - Whether a Request is Allowed or Denied in the IAM User Guide. - -
  • - - The principal who made the request. - -
  • - - The requested action. - -
  • - - The requested resource. - -
  • - - The values of condition keys in the context of the user's request. - -
- - Container for the necessary parameters to execute the DecodeAuthorizationMessage service method. - - The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService. - - The error returned if the message passed to DecodeAuthorizationMessage - was invalid. This can happen if the token contains invalid characters, such as linebreaks. - - REST API Reference for DecodeAuthorizationMessage Operation - - - - Decodes additional information about the authorization status of a request from an - encoded message returned in response to an AWS request. - - - - For example, if a user is not authorized to perform an operation that he or she has - requested, the request returns a Client.UnauthorizedOperation response - (an HTTP 403 response). Some AWS operations additionally return an encoded message - that can provide details about this authorization failure. - - - - Only certain AWS operations return an encoded authorization message. The documentation - for an individual operation indicates whether that operation returns an encoded message - in addition to returning an HTTP code. - - - - The message is encoded because the details of the authorization status can constitute - privileged information that the user who requested the operation should not see. To - decode an authorization status message, a user must be granted permissions via an - IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) - action. - - - - The decoded message includes the following type of information: - -
  • - - Whether the request was denied due to an explicit deny or due to the absence of an - explicit allow. For more information, see Determining - Whether a Request is Allowed or Denied in the IAM User Guide. - -
  • - - The principal who made the request. - -
  • - - The requested action. - -
  • - - The requested resource. - -
  • - - The values of condition keys in the context of the user's request. - -
- - Container for the necessary parameters to execute the DecodeAuthorizationMessage service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService. - - The error returned if the message passed to DecodeAuthorizationMessage - was invalid. This can happen if the token contains invalid characters, such as linebreaks. - - REST API Reference for DecodeAuthorizationMessage Operation - - - - Returns the account identifier for the specified access key ID. - - - - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) - and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). - For more information about access keys, see Managing - Access Keys for IAM Users in the IAM User Guide. - - - - When you pass an access key ID to this operation, it returns the ID of the AWS account - to which the keys belong. Access key IDs beginning with AKIA are long-term - credentials for an IAM user or the AWS account root user. Access key IDs beginning - with ASIA are temporary credentials that are created using STS operations. - If the account in the response belongs to you, you can sign in as the root user and - review your root user access keys. Then, you can pull a credentials - report to learn which IAM user owns the keys. To learn who requested the temporary - credentials for an ASIA access key, view the STS events in your CloudTrail - logs in the IAM User Guide. - - - - This operation does not indicate the state of the access key. The key might be active, - inactive, or deleted. Active keys might not have permissions to perform an operation. - Providing a deleted access key might return an error that the key doesn't exist. - - - Container for the necessary parameters to execute the GetAccessKeyInfo service method. - - The response from the GetAccessKeyInfo service method, as returned by SecurityTokenService. - REST API Reference for GetAccessKeyInfo Operation - - - - Returns the account identifier for the specified access key ID. - - - - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) - and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). - For more information about access keys, see Managing - Access Keys for IAM Users in the IAM User Guide. - - - - When you pass an access key ID to this operation, it returns the ID of the AWS account - to which the keys belong. Access key IDs beginning with AKIA are long-term - credentials for an IAM user or the AWS account root user. Access key IDs beginning - with ASIA are temporary credentials that are created using STS operations. - If the account in the response belongs to you, you can sign in as the root user and - review your root user access keys. Then, you can pull a credentials - report to learn which IAM user owns the keys. To learn who requested the temporary - credentials for an ASIA access key, view the STS events in your CloudTrail - logs in the IAM User Guide. - - - - This operation does not indicate the state of the access key. The key might be active, - inactive, or deleted. Active keys might not have permissions to perform an operation. - Providing a deleted access key might return an error that the key doesn't exist. - - - Container for the necessary parameters to execute the GetAccessKeyInfo service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetAccessKeyInfo service method, as returned by SecurityTokenService. - REST API Reference for GetAccessKeyInfo Operation - - - - Returns details about the IAM user or role whose credentials are used to call the - operation. - - - - No permissions are required to perform this operation. If an administrator adds a - policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity - action, you can still perform this operation. Permissions are not required because - the same information is returned when an IAM user or role is denied access. To view - an example response, see I - Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetCallerIdentity service method. - - The response from the GetCallerIdentity service method, as returned by SecurityTokenService. - REST API Reference for GetCallerIdentity Operation - - - - Returns details about the IAM user or role whose credentials are used to call the - operation. - - - - No permissions are required to perform this operation. If an administrator adds a - policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity - action, you can still perform this operation. Permissions are not required because - the same information is returned when an IAM user or role is denied access. To view - an example response, see I - Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetCallerIdentity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCallerIdentity service method, as returned by SecurityTokenService. - REST API Reference for GetCallerIdentity Operation - - - - Returns a set of temporary security credentials (consisting of an access key ID, a - secret access key, and a security token) for a federated user. A typical use is in - a proxy application that gets temporary security credentials on behalf of distributed - applications inside a corporate network. You must call the GetFederationToken - operation using the long-term security credentials of an IAM user. As a result, this - call is appropriate in contexts where those credentials can be safely stored, usually - in a server-based application. For a comparison of GetFederationToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plain text that you use for both inline and managed - session policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the user that you are federating has the Department=Marketing - tag and you pass the department=engineering session tag. - Department and department are not saved as separate tags, - and the session tag passed in the request takes precedence over the user tag. - - - Container for the necessary parameters to execute the GetFederationToken service method. - - The response from the GetFederationToken service method, as returned by SecurityTokenService. - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetFederationToken Operation - - - - Returns a set of temporary security credentials (consisting of an access key ID, a - secret access key, and a security token) for a federated user. A typical use is in - a proxy application that gets temporary security credentials on behalf of distributed - applications inside a corporate network. You must call the GetFederationToken - operation using the long-term security credentials of an IAM user. As a result, this - call is appropriate in contexts where those credentials can be safely stored, usually - in a server-based application. For a comparison of GetFederationToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plain text that you use for both inline and managed - session policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the user that you are federating has the Department=Marketing - tag and you pass the department=engineering session tag. - Department and department are not saved as separate tags, - and the session tag passed in the request takes precedence over the user tag. - - - Container for the necessary parameters to execute the GetFederationToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetFederationToken service method, as returned by SecurityTokenService. - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetFederationToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetSessionToken service method. - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetSessionToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Configuration for accessing Amazon SecurityTokenService service - - - - - StsRegionalEndpoints should be set to StsRegionalEndpointsValue.Legacy to resolve to the global - sts endpoint (only for legacy global regions) or StsRegionalEndpointsValue.Regional to resolve to - the regional sts endpoint. The default value for StsRegionalEndpoints is StsRegionalEndpointsValue.Legacy. - - Get the Sts Regional Flag value - by checking the environment variable - and shared credentials file field - - - - - Override DetermineServiceURL to set the url to the - global endpoint if the sts regional flag is equal to legacy - and the region is a legacy global region - - url: A string url for the request - - - - If the sts regional flag environment variable is set, then first validate that - it is an acceptable value, if not, then throw an error. Then - set the sts regional flag to that value. - - _isRegionalFlagSet: a boolean for whether or not - the environment variable set the regional flag - - - - Check the credential file for an sts regional endpoints - option. If it is set within the file, then set the sts - regional flag to that value. - - _isRegionalFlagSet: A boolean for whether - or not the credentials file set the regional flag - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Credentials that are retrieved by invoking AWS Security Token Service - AssumeRole or AssumeRoleWithSAML action. - - - Assumed role credentials retrieved and automatically refreshed from - an instance of IAmazonSecurityTokenService. - - - - - Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified role. - The credentials are refreshed before expiration. - - - Instance of IAmazonSecurityTokenService that will be used to make the AssumeRole service call. - - Configuration for the role to assume. - - - - Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified SAML role. - The credentials are refreshed before expiration. - - Configuration for the SAML role to assume. - - - - Generate new credentials. - - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Interface for accessing SecurityTokenService - - AWS Security Token Service - - AWS Security Token Service (STS) enables you to request temporary, limited-privilege - credentials for AWS Identity and Access Management (IAM) users or for users that you - authenticate (federated users). This guide provides descriptions of the STS API. For - more information about using this service, see Temporary - Security Credentials. - - - - - - Returns a set of temporary security credentials that you can use to access AWS resources - that you might not normally have access to. These temporary credentials consist of - an access key ID, a secret access key, and a security token. Typically, you use AssumeRole - within your account or for cross-account access. For a comparison of AssumeRole - with other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRole can be used - to make API calls to any AWS service with the following exception: You cannot call - the AWS STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - To assume a role from a different account, your AWS account must be trusted by the - role. The trust relationship is defined in the role's trust policy when the role is - created. That trust policy states which accounts are allowed to delegate that access - to users in the account. - - - - A user who wants to access a role in a different account must also have permissions - that are delegated from the user account administrator. The administrator must attach - a policy that allows the user to call AssumeRole for the ARN of the role - in the other account. If the user is in the same account as the role, then you can - do either of the following: - -
  • - - Attach a policy to the user (identical to the previous user in a different account). - -
  • - - Add the user as a principal directly in the role's trust policy. - -
- - In this case, the trust policy acts as an IAM resource-based policy. Users in the - same account as the role do not need explicit permission to assume the role. For more - information about trust policies and resource-based policies, see IAM - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These tags are called - session tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Using MFA with AssumeRole - - - - (Optional) You can include multi-factor authentication (MFA) information when you - call AssumeRole. This is useful for cross-account scenarios to ensure - that the user that assumes the role has been authenticated with an AWS MFA device. - In that scenario, the trust policy of the role being assumed includes a condition - that tests for MFA authentication. If the caller does not include valid MFA information, - the request to assume the role is denied. The condition in a trust policy that tests - for MFA authentication might look like the following example. - - - - "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} - - - - For more information, see Configuring - MFA-Protected API Access in the IAM User Guide guide. - - - - To use MFA with AssumeRole, you pass values for the SerialNumber - and TokenCode parameters. The SerialNumber value identifies - the user's hardware or virtual MFA device. The TokenCode is the time-based - one-time password (TOTP) that the MFA device produces. - - - Container for the necessary parameters to execute the AssumeRole service method. - - The response from the AssumeRole service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRole Operation - - - - Returns a set of temporary security credentials that you can use to access AWS resources - that you might not normally have access to. These temporary credentials consist of - an access key ID, a secret access key, and a security token. Typically, you use AssumeRole - within your account or for cross-account access. For a comparison of AssumeRole - with other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRole can be used - to make API calls to any AWS service with the following exception: You cannot call - the AWS STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - To assume a role from a different account, your AWS account must be trusted by the - role. The trust relationship is defined in the role's trust policy when the role is - created. That trust policy states which accounts are allowed to delegate that access - to users in the account. - - - - A user who wants to access a role in a different account must also have permissions - that are delegated from the user account administrator. The administrator must attach - a policy that allows the user to call AssumeRole for the ARN of the role - in the other account. If the user is in the same account as the role, then you can - do either of the following: - -
  • - - Attach a policy to the user (identical to the previous user in a different account). - -
  • - - Add the user as a principal directly in the role's trust policy. - -
- - In this case, the trust policy acts as an IAM resource-based policy. Users in the - same account as the role do not need explicit permission to assume the role. For more - information about trust policies and resource-based policies, see IAM - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These tags are called - session tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Using MFA with AssumeRole - - - - (Optional) You can include multi-factor authentication (MFA) information when you - call AssumeRole. This is useful for cross-account scenarios to ensure - that the user that assumes the role has been authenticated with an AWS MFA device. - In that scenario, the trust policy of the role being assumed includes a condition - that tests for MFA authentication. If the caller does not include valid MFA information, - the request to assume the role is denied. The condition in a trust policy that tests - for MFA authentication might look like the following example. - - - - "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} - - - - For more information, see Configuring - MFA-Protected API Access in the IAM User Guide guide. - - - - To use MFA with AssumeRole, you pass values for the SerialNumber - and TokenCode parameters. The SerialNumber value identifies - the user's hardware or virtual MFA device. The TokenCode is the time-based - one-time password (TOTP) that the MFA device produces. - - - Container for the necessary parameters to execute the AssumeRole service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRole service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRole Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - via a SAML authentication response. This operation provides a mechanism for tying - an enterprise identity store or directory to role-based AWS access without user-specific - credentials or configuration. For a comparison of AssumeRoleWithSAML - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this operation consist of an access - key ID, a secret access key, and a security token. Applications can use these temporary - security credentials to sign calls to AWS services. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithSAML - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. Your role session lasts for the - duration that you specify, or until the time specified in the SAML authentication - response's SessionNotOnOrAfter value, whichever is shorter. You can provide - a DurationSeconds value from 900 seconds (15 minutes) up to the maximum - session duration setting for the role. This setting can have a value from 1 hour to - 12 hours. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Role - chaining limits your AWS CLI or AWS API role session to a maximum of one hour. - When you use the AssumeRole API operation to assume a role, you can specify - the duration of your role session with the DurationSeconds parameter. - You can specify a parameter value of up to 43200 seconds (12 hours), depending on - the maximum session duration setting for your role. However, if you assume a role - using role chaining and provide a DurationSeconds parameter value greater - than one hour, the operation fails. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithSAML can - be used to make API calls to any AWS service with the following exception: you cannot - call the STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Calling AssumeRoleWithSAML does not require the use of AWS security credentials. - The identity of the caller is validated by using keys in the metadata document that - is uploaded for the SAML provider entity for your identity provider. - - - - Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail - logs. The entry includes the value in the NameID element of the SAML - assertion. We recommend that you use a NameIDType that is not associated - with any personally identifiable information (PII). For example, you could instead - use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your SAML assertion - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, session tags override the role's tags with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - SAML Configuration - - - - Before your application can call AssumeRoleWithSAML, you must configure - your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, - you must use AWS Identity and Access Management (IAM) to create a SAML provider entity - in your AWS account that represents your identity provider. You must also create an - IAM role that specifies this SAML provider in its trust policy. - - - - For more information, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithSAML service method. - - The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithSAML Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - via a SAML authentication response. This operation provides a mechanism for tying - an enterprise identity store or directory to role-based AWS access without user-specific - credentials or configuration. For a comparison of AssumeRoleWithSAML - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this operation consist of an access - key ID, a secret access key, and a security token. Applications can use these temporary - security credentials to sign calls to AWS services. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithSAML - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. Your role session lasts for the - duration that you specify, or until the time specified in the SAML authentication - response's SessionNotOnOrAfter value, whichever is shorter. You can provide - a DurationSeconds value from 900 seconds (15 minutes) up to the maximum - session duration setting for the role. This setting can have a value from 1 hour to - 12 hours. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Role - chaining limits your AWS CLI or AWS API role session to a maximum of one hour. - When you use the AssumeRole API operation to assume a role, you can specify - the duration of your role session with the DurationSeconds parameter. - You can specify a parameter value of up to 43200 seconds (12 hours), depending on - the maximum session duration setting for your role. However, if you assume a role - using role chaining and provide a DurationSeconds parameter value greater - than one hour, the operation fails. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithSAML can - be used to make API calls to any AWS service with the following exception: you cannot - call the STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Calling AssumeRoleWithSAML does not require the use of AWS security credentials. - The identity of the caller is validated by using keys in the metadata document that - is uploaded for the SAML provider entity for your identity provider. - - - - Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail - logs. The entry includes the value in the NameID element of the SAML - assertion. We recommend that you use a NameIDType that is not associated - with any personally identifiable information (PII). For example, you could instead - use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your SAML assertion - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, session tags override the role's tags with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - SAML Configuration - - - - Before your application can call AssumeRoleWithSAML, you must configure - your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, - you must use AWS Identity and Access Management (IAM) to create a SAML provider entity - in your AWS account that represents your identity provider. You must also create an - IAM role that specifies this SAML provider in its trust policy. - - - - For more information, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithSAML service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithSAML Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - in a mobile or web application with a web identity provider. Example providers include - Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible - identity provider. - - - - For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon - Cognito with the AWS SDK for iOS Developer - Guide and the AWS SDK for Android - Developer Guide to uniquely identify a user. You can also supply the user with - a consistent identity throughout the lifetime of an application. - - - - To learn more about Amazon Cognito, see Amazon - Cognito Overview in AWS SDK for Android Developer Guide and Amazon - Cognito Overview in the AWS SDK for iOS Developer Guide. - - - - Calling AssumeRoleWithWebIdentity does not require the use of AWS security - credentials. Therefore, you can distribute an application (for example, on mobile - devices) that requests temporary security credentials without including long-term - AWS credentials in the application. You also don't need to deploy server-based proxy - services that use long-term AWS credentials. Instead, the identity of the caller is - validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this API consist of an access key ID, - a secret access key, and a security token. Applications can use these temporary security - credentials to sign calls to AWS service API operations. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithWebIdentity - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. You can provide a value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. To learn how to view the maximum - value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithWebIdentity - can be used to make API calls to any AWS service with the following exception: you - cannot call the STS GetFederationToken or GetSessionToken - API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your web identity token - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, the session tag overrides the role tag with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Identities - - - - Before your application can call AssumeRoleWithWebIdentity, you must - have an identity token from a supported identity provider and create a role that the - application can assume. The role that your application assumes must trust the identity - provider that is associated with the identity token. In other words, the identity - provider must be specified in the role's trust policy. - - - - Calling AssumeRoleWithWebIdentity can result in an entry in your AWS - CloudTrail logs. The entry includes the Subject - of the provided web identity token. We recommend that you avoid using any personally - identifiable information (PII) in this field. For example, you could instead use a - GUID or a pairwise identifier, as suggested - in the OIDC specification. - - - - For more information about how to use web identity federation and the AssumeRoleWithWebIdentity - API, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method. - - The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request could not be fulfilled because the identity provider (IDP) that was asked - to verify the incoming identity token could not be reached. This is often a transient - error caused by network conditions. Retry the request a limited number of times so - that you don't exceed the request rate. If the error persists, the identity provider - might be down or not responding. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithWebIdentity Operation - - - - Returns a set of temporary security credentials for users who have been authenticated - in a mobile or web application with a web identity provider. Example providers include - Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible - identity provider. - - - - For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon - Cognito with the AWS SDK for iOS Developer - Guide and the AWS SDK for Android - Developer Guide to uniquely identify a user. You can also supply the user with - a consistent identity throughout the lifetime of an application. - - - - To learn more about Amazon Cognito, see Amazon - Cognito Overview in AWS SDK for Android Developer Guide and Amazon - Cognito Overview in the AWS SDK for iOS Developer Guide. - - - - Calling AssumeRoleWithWebIdentity does not require the use of AWS security - credentials. Therefore, you can distribute an application (for example, on mobile - devices) that requests temporary security credentials without including long-term - AWS credentials in the application. You also don't need to deploy server-based proxy - services that use long-term AWS credentials. Instead, the identity of the caller is - validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this API consist of an access key ID, - a secret access key, and a security token. Applications can use these temporary security - credentials to sign calls to AWS service API operations. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithWebIdentity - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. You can provide a value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. To learn how to view the maximum - value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithWebIdentity - can be used to make API calls to any AWS service with the following exception: you - cannot call the STS GetFederationToken or GetSessionToken - API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your web identity token - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, the session tag overrides the role tag with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Identities - - - - Before your application can call AssumeRoleWithWebIdentity, you must - have an identity token from a supported identity provider and create a role that the - application can assume. The role that your application assumes must trust the identity - provider that is associated with the identity token. In other words, the identity - provider must be specified in the role's trust policy. - - - - Calling AssumeRoleWithWebIdentity can result in an entry in your AWS - CloudTrail logs. The entry includes the Subject - of the provided web identity token. We recommend that you avoid using any personally - identifiable information (PII) in this field. For example, you could instead use a - GUID or a pairwise identifier, as suggested - in the OIDC specification. - - - - For more information about how to use web identity federation and the AssumeRoleWithWebIdentity - API, see the following resources: - - - - Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService. - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - The request could not be fulfilled because the identity provider (IDP) that was asked - to verify the incoming identity token could not be reached. This is often a transient - error caused by network conditions. Retry the request a limited number of times so - that you don't exceed the request rate. If the error persists, the identity provider - might be down or not responding. - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for AssumeRoleWithWebIdentity Operation - - - - Decodes additional information about the authorization status of a request from an - encoded message returned in response to an AWS request. - - - - For example, if a user is not authorized to perform an operation that he or she has - requested, the request returns a Client.UnauthorizedOperation response - (an HTTP 403 response). Some AWS operations additionally return an encoded message - that can provide details about this authorization failure. - - - - Only certain AWS operations return an encoded authorization message. The documentation - for an individual operation indicates whether that operation returns an encoded message - in addition to returning an HTTP code. - - - - The message is encoded because the details of the authorization status can constitute - privileged information that the user who requested the operation should not see. To - decode an authorization status message, a user must be granted permissions via an - IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) - action. - - - - The decoded message includes the following type of information: - -
  • - - Whether the request was denied due to an explicit deny or due to the absence of an - explicit allow. For more information, see Determining - Whether a Request is Allowed or Denied in the IAM User Guide. - -
  • - - The principal who made the request. - -
  • - - The requested action. - -
  • - - The requested resource. - -
  • - - The values of condition keys in the context of the user's request. - -
- - Container for the necessary parameters to execute the DecodeAuthorizationMessage service method. - - The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService. - - The error returned if the message passed to DecodeAuthorizationMessage - was invalid. This can happen if the token contains invalid characters, such as linebreaks. - - REST API Reference for DecodeAuthorizationMessage Operation - - - - Decodes additional information about the authorization status of a request from an - encoded message returned in response to an AWS request. - - - - For example, if a user is not authorized to perform an operation that he or she has - requested, the request returns a Client.UnauthorizedOperation response - (an HTTP 403 response). Some AWS operations additionally return an encoded message - that can provide details about this authorization failure. - - - - Only certain AWS operations return an encoded authorization message. The documentation - for an individual operation indicates whether that operation returns an encoded message - in addition to returning an HTTP code. - - - - The message is encoded because the details of the authorization status can constitute - privileged information that the user who requested the operation should not see. To - decode an authorization status message, a user must be granted permissions via an - IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) - action. - - - - The decoded message includes the following type of information: - -
  • - - Whether the request was denied due to an explicit deny or due to the absence of an - explicit allow. For more information, see Determining - Whether a Request is Allowed or Denied in the IAM User Guide. - -
  • - - The principal who made the request. - -
  • - - The requested action. - -
  • - - The requested resource. - -
  • - - The values of condition keys in the context of the user's request. - -
- - Container for the necessary parameters to execute the DecodeAuthorizationMessage service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService. - - The error returned if the message passed to DecodeAuthorizationMessage - was invalid. This can happen if the token contains invalid characters, such as linebreaks. - - REST API Reference for DecodeAuthorizationMessage Operation - - - - Returns the account identifier for the specified access key ID. - - - - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) - and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). - For more information about access keys, see Managing - Access Keys for IAM Users in the IAM User Guide. - - - - When you pass an access key ID to this operation, it returns the ID of the AWS account - to which the keys belong. Access key IDs beginning with AKIA are long-term - credentials for an IAM user or the AWS account root user. Access key IDs beginning - with ASIA are temporary credentials that are created using STS operations. - If the account in the response belongs to you, you can sign in as the root user and - review your root user access keys. Then, you can pull a credentials - report to learn which IAM user owns the keys. To learn who requested the temporary - credentials for an ASIA access key, view the STS events in your CloudTrail - logs in the IAM User Guide. - - - - This operation does not indicate the state of the access key. The key might be active, - inactive, or deleted. Active keys might not have permissions to perform an operation. - Providing a deleted access key might return an error that the key doesn't exist. - - - Container for the necessary parameters to execute the GetAccessKeyInfo service method. - - The response from the GetAccessKeyInfo service method, as returned by SecurityTokenService. - REST API Reference for GetAccessKeyInfo Operation - - - - Returns the account identifier for the specified access key ID. - - - - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) - and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). - For more information about access keys, see Managing - Access Keys for IAM Users in the IAM User Guide. - - - - When you pass an access key ID to this operation, it returns the ID of the AWS account - to which the keys belong. Access key IDs beginning with AKIA are long-term - credentials for an IAM user or the AWS account root user. Access key IDs beginning - with ASIA are temporary credentials that are created using STS operations. - If the account in the response belongs to you, you can sign in as the root user and - review your root user access keys. Then, you can pull a credentials - report to learn which IAM user owns the keys. To learn who requested the temporary - credentials for an ASIA access key, view the STS events in your CloudTrail - logs in the IAM User Guide. - - - - This operation does not indicate the state of the access key. The key might be active, - inactive, or deleted. Active keys might not have permissions to perform an operation. - Providing a deleted access key might return an error that the key doesn't exist. - - - Container for the necessary parameters to execute the GetAccessKeyInfo service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetAccessKeyInfo service method, as returned by SecurityTokenService. - REST API Reference for GetAccessKeyInfo Operation - - - - Returns details about the IAM user or role whose credentials are used to call the - operation. - - - - No permissions are required to perform this operation. If an administrator adds a - policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity - action, you can still perform this operation. Permissions are not required because - the same information is returned when an IAM user or role is denied access. To view - an example response, see I - Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetCallerIdentity service method. - - The response from the GetCallerIdentity service method, as returned by SecurityTokenService. - REST API Reference for GetCallerIdentity Operation - - - - Returns details about the IAM user or role whose credentials are used to call the - operation. - - - - No permissions are required to perform this operation. If an administrator adds a - policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity - action, you can still perform this operation. Permissions are not required because - the same information is returned when an IAM user or role is denied access. To view - an example response, see I - Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetCallerIdentity service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCallerIdentity service method, as returned by SecurityTokenService. - REST API Reference for GetCallerIdentity Operation - - - - Returns a set of temporary security credentials (consisting of an access key ID, a - secret access key, and a security token) for a federated user. A typical use is in - a proxy application that gets temporary security credentials on behalf of distributed - applications inside a corporate network. You must call the GetFederationToken - operation using the long-term security credentials of an IAM user. As a result, this - call is appropriate in contexts where those credentials can be safely stored, usually - in a server-based application. For a comparison of GetFederationToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plain text that you use for both inline and managed - session policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the user that you are federating has the Department=Marketing - tag and you pass the department=engineering session tag. - Department and department are not saved as separate tags, - and the session tag passed in the request takes precedence over the user tag. - - - Container for the necessary parameters to execute the GetFederationToken service method. - - The response from the GetFederationToken service method, as returned by SecurityTokenService. - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetFederationToken Operation - - - - Returns a set of temporary security credentials (consisting of an access key ID, a - secret access key, and a security token) for a federated user. A typical use is in - a proxy application that gets temporary security credentials on behalf of distributed - applications inside a corporate network. You must call the GetFederationToken - operation using the long-term security credentials of an IAM user. As a result, this - call is appropriate in contexts where those credentials can be safely stored, usually - in a server-based application. For a comparison of GetFederationToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plain text that you use for both inline and managed - session policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the user that you are federating has the Department=Marketing - tag and you pass the department=engineering session tag. - Department and department are not saved as separate tags, - and the session tag passed in the request takes precedence over the user tag. - - - Container for the necessary parameters to execute the GetFederationToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetFederationToken service method, as returned by SecurityTokenService. - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetFederationToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetSessionToken service method. - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - Container for the necessary parameters to execute the GetSessionToken service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetSessionToken service method, as returned by SecurityTokenService. - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - REST API Reference for GetSessionToken Operation - - - - AWS credentials for API authentication. - - - AWS credentials for API authentication. - - - - - Returns a copy of ImmutableCredentials corresponding to these credentials - - - - - - Empty constructor used to set properties independently even when a simple constructor is available - - - - - Instantiates Credentials with the parameterized properties - - The access key ID that identifies the temporary security credentials. - The secret access key that can be used to sign requests. - The token that users must pass to the service API to use the temporary credentials. - The date on which the current credentials expire. - - - - Gets and sets the property AccessKeyId. - - The access key ID that identifies the temporary security credentials. - - - - - - Gets and sets the property Expiration. - - The date on which the current credentials expire. - - - - - - Gets and sets the property SecretAccessKey. - - The secret access key that can be used to sign requests. - - - - - - Gets and sets the property SessionToken. - - The token that users must pass to the service API to use the temporary credentials. - - - - - - The identifiers for the temporary security credentials that the operation returns. - - - - - Gets and sets the property Arn. - - The ARN of the temporary security credentials that are returned from the AssumeRole - action. For more information about ARNs and how to use them in policies, see IAM - Identifiers in the IAM User Guide. - - - - - - Gets and sets the property AssumedRoleId. - - A unique identifier that contains the role ID and the role session name of the role - that is being assumed. The role ID is generated by AWS when the role is created. - - - - - - Container for the parameters to the AssumeRole operation. - Returns a set of temporary security credentials that you can use to access AWS resources - that you might not normally have access to. These temporary credentials consist of - an access key ID, a secret access key, and a security token. Typically, you use AssumeRole - within your account or for cross-account access. For a comparison of AssumeRole - with other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRole can be used - to make API calls to any AWS service with the following exception: You cannot call - the AWS STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - To assume a role from a different account, your AWS account must be trusted by the - role. The trust relationship is defined in the role's trust policy when the role is - created. That trust policy states which accounts are allowed to delegate that access - to users in the account. - - - - A user who wants to access a role in a different account must also have permissions - that are delegated from the user account administrator. The administrator must attach - a policy that allows the user to call AssumeRole for the ARN of the role - in the other account. If the user is in the same account as the role, then you can - do either of the following: - -
  • - - Attach a policy to the user (identical to the previous user in a different account). - -
  • - - Add the user as a principal directly in the role's trust policy. - -
- - In this case, the trust policy acts as an IAM resource-based policy. Users in the - same account as the role do not need explicit permission to assume the role. For more - information about trust policies and resource-based policies, see IAM - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These tags are called - session tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Using MFA with AssumeRole - - - - (Optional) You can include multi-factor authentication (MFA) information when you - call AssumeRole. This is useful for cross-account scenarios to ensure - that the user that assumes the role has been authenticated with an AWS MFA device. - In that scenario, the trust policy of the role being assumed includes a condition - that tests for MFA authentication. If the caller does not include valid MFA information, - the request to assume the role is denied. The condition in a trust policy that tests - for MFA authentication might look like the following example. - - - - "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} - - - - For more information, see Configuring - MFA-Protected API Access in the IAM User Guide guide. - - - - To use MFA with AssumeRole, you pass values for the SerialNumber - and TokenCode parameters. The SerialNumber value identifies - the user's hardware or virtual MFA device. The TokenCode is the time-based - one-time password (TOTP) that the MFA device produces. - - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value specified can can range from - 900 seconds (15 minutes) up to the maximum session duration that is set for the role. - The maximum session duration setting can have a value from 1 hour to 12 hours. If - you specify a value higher than this setting or the administrator setting (whichever - is lower), the operation fails. For example, if you specify a session duration of - 12 hours, but your administrator set the maximum session duration to 6 hours, your - operation fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ExternalId. - - A unique identifier that might be required when you assume a role in another account. - If the administrator of the account to which the role belongs provided you with an - external ID, then provide that value in the ExternalId parameter. This - value can be any string, such as a passphrase or account number. A cross-account role - is usually set up to trust everyone in an account. Therefore, the administrator of - the trusting account might send an external ID to the administrator of the trusted - account. That way, only someone with the ID can assume the role, rather than everyone - in the account. For more information about the external ID, see How - to Use an External ID When Granting Access to Your AWS Resources to a Third Party - in the IAM User Guide. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@:/- - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. The JSON policy characters can be any ASCII character from the space - character to the end of the valid character list (\u0020 through \u00FF). It can also - include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) of the role to assume. - - - - - - Gets and sets the property RoleSessionName. - - An identifier for the assumed role session. - - - - Use the role session name to uniquely identify a session when the same role is assumed - by different principals or for different reasons. In cross-account scenarios, the - role session name is visible to, and can be logged by the account that owns the role. - The role session name is also used in the ARN of the assumed role principal. This - means that subsequent cross-account API requests that use the temporary security credentials - will expose the role session name to the external account in their AWS CloudTrail - logs. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property SerialNumber. - - The identification number of the MFA device that is associated with the user who is - making the AssumeRole call. Specify this value if the trust policy of - the role being assumed includes a condition that requires MFA authentication. The - value is either the serial number for a hardware device (such as GAHT12345678) - or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property SourceIdentity. - - The source identity specified by the principal that is calling the AssumeRole - operation. - - - - You can require users to specify a source identity when they assume a role. You do - this by using the sts:SourceIdentity condition key in a role trust policy. - You can use source identity information in AWS CloudTrail logs to determine who took - actions with a role. You can use the aws:SourceIdentity condition key - to further control access to AWS resources based on the value of source identity. - For more information about using source identity, see Monitor - and control actions taken with assumed roles in the IAM User Guide. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@-. You cannot use a value that - begins with the text aws:. This prefix is reserved for AWS internal use. - - - - - - Gets and sets the property Tags. - - A list of session tags that you want to pass. Each session tag consists of a key name - and an associated value. For more information about session tags, see Tagging - AWS STS Sessions in the IAM User Guide. - - - - This parameter is optional. You can pass up to 50 session tags. The plaintext session - tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. - For these and additional limits, see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is already attached to - the role. When you do, session tags override a role tag with the same key. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the role has the Department=Marketing tag and - you pass the department=engineering session tag. Department - and department are not saved as separate tags, and the session tag passed - in the request takes precedence over the role tag. - - - - Additionally, if you used temporary credentials to perform this operation, the new - session inherits any transitive session tags from the calling session. If you pass - a session tag with the same key as an inherited tag, the operation fails. To view - the inherited tags for a session, see the AWS CloudTrail logs. For more information, - see Viewing - Session Tags in CloudTrail in the IAM User Guide. - - - - - - Gets and sets the property TokenCode. - - The value provided by the MFA device, if the trust policy of the role being assumed - requires MFA. (In other words, if the policy includes a condition that tests for MFA). - If the role being assumed requires MFA and if the TokenCode value is - missing or expired, the AssumeRole call returns an "access denied" error. - - - - The format for this parameter, as described by its regex pattern, is a sequence of - six numeric digits. - - - - - - Gets and sets the property TransitiveTagKeys. - - A list of keys for session tags that you want to set as transitive. If you set a tag - key as transitive, the corresponding key and value passes to subsequent sessions in - a role chain. For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - This parameter is optional. When you set session tags as transitive, the session policy - and session tags packed binary limit is not affected. - - - - If you choose not to specify a transitive tag key, then no tags are passed from this - session to any subsequent sessions. - - - - - - Contains the response to a successful AssumeRole request, including temporary - AWS credentials that can be used to make AWS requests. - - - - - Gets and sets the property AssumedRoleUser. - - The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that - you can use to refer to the resulting temporary security credentials. For example, - you can reference these credentials as a principal in a resource-based policy by using - the ARN or assumed role ID. The ARN and ID include the RoleSessionName - that you specified when you called AssumeRole. - - - - - - Gets and sets the property Credentials. - - The temporary security credentials, which include an access key ID, a secret access - key, and a security (or session) token. - - - - The size of the security token that STS API operations return is not fixed. We strongly - recommend that you make no assumptions about the maximum size. - - - - - - - Gets and sets the property PackedPolicySize. - - A percentage value that indicates the packed size of the session policies and session - tags combined passed in the request. The request fails if the packed size is greater - than 100 percent, which means the policies and tags exceeded the allowed space. - - - - - - Gets and sets the property SourceIdentity. - - The source identity specified by the principal that is calling the AssumeRole - operation. - - - - You can require users to specify a source identity when they assume a role. You do - this by using the sts:SourceIdentity condition key in a role trust policy. - You can use source identity information in AWS CloudTrail logs to determine who took - actions with a role. You can use the aws:SourceIdentity condition key - to further control access to AWS resources based on the value of source identity. - For more information about using source identity, see Monitor - and control actions taken with assumed roles in the IAM User Guide. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Container for the parameters to the AssumeRoleWithSAML operation. - Returns a set of temporary security credentials for users who have been authenticated - via a SAML authentication response. This operation provides a mechanism for tying - an enterprise identity store or directory to role-based AWS access without user-specific - credentials or configuration. For a comparison of AssumeRoleWithSAML - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this operation consist of an access - key ID, a secret access key, and a security token. Applications can use these temporary - security credentials to sign calls to AWS services. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithSAML - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. Your role session lasts for the - duration that you specify, or until the time specified in the SAML authentication - response's SessionNotOnOrAfter value, whichever is shorter. You can provide - a DurationSeconds value from 900 seconds (15 minutes) up to the maximum - session duration setting for the role. This setting can have a value from 1 hour to - 12 hours. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Role - chaining limits your AWS CLI or AWS API role session to a maximum of one hour. - When you use the AssumeRole API operation to assume a role, you can specify - the duration of your role session with the DurationSeconds parameter. - You can specify a parameter value of up to 43200 seconds (12 hours), depending on - the maximum session duration setting for your role. However, if you assume a role - using role chaining and provide a DurationSeconds parameter value greater - than one hour, the operation fails. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithSAML can - be used to make API calls to any AWS service with the following exception: you cannot - call the STS GetFederationToken or GetSessionToken API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Calling AssumeRoleWithSAML does not require the use of AWS security credentials. - The identity of the caller is validated by using keys in the metadata document that - is uploaded for the SAML provider entity for your identity provider. - - - - Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail - logs. The entry includes the value in the NameID element of the SAML - assertion. We recommend that you use a NameIDType that is not associated - with any personally identifiable information (PII). For example, you could instead - use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your SAML assertion - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, session tags override the role's tags with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - SAML Configuration - - - - Before your application can call AssumeRoleWithSAML, you must configure - your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, - you must use AWS Identity and Access Management (IAM) to create a SAML provider entity - in your AWS account that represents your identity provider. You must also create an - IAM role that specifies this SAML provider in its trust policy. - - - - For more information, see the following resources: - - - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. Your role session lasts for the duration - that you specify for the DurationSeconds parameter, or until the time - specified in the SAML authentication response's SessionNotOnOrAfter value, - whichever is shorter. You can provide a DurationSeconds value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. If you specify a value higher than - this setting, the operation fails. For example, if you specify a session duration - of 12 hours, but your administrator set the maximum session duration to 6 hours, your - operation fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. The JSON policy characters can be any ASCII character from the space - character to the end of the valid character list (\u0020 through \u00FF). It can also - include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - Gets and sets the property PrincipalArn. - - The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) of the role that the caller is assuming. - - - - - - Gets and sets the property SAMLAssertion. - - The base64 encoded SAML authentication response provided by the IdP. - - - - For more information, see Configuring - a Relying Party and Adding Claims in the IAM User Guide. - - - - - - Contains the response to a successful AssumeRoleWithSAML request, including - temporary AWS credentials that can be used to make AWS requests. - - - - - Gets and sets the property AssumedRoleUser. - - The identifiers for the temporary security credentials that the operation returns. - - - - - - Gets and sets the property Audience. - - The value of the Recipient attribute of the SubjectConfirmationData - element of the SAML assertion. - - - - - - Gets and sets the property Credentials. - - The temporary security credentials, which include an access key ID, a secret access - key, and a security (or session) token. - - - - The size of the security token that STS API operations return is not fixed. We strongly - recommend that you make no assumptions about the maximum size. - - - - - - - Gets and sets the property Issuer. - - The value of the Issuer element of the SAML assertion. - - - - - - Gets and sets the property NameQualifier. - - A hash value based on the concatenation of the following: - -
  • - - The Issuer response value. - -
  • - - The AWS account ID. - -
  • - - The friendly name (the last part of the ARN) of the SAML provider in IAM. - -
- - The combination of NameQualifier and Subject can be used - to uniquely identify a federated user. - - - - The following pseudocode shows how the hash value is calculated: - - - - BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" - ) ) - - - - - - Gets and sets the property PackedPolicySize. - - A percentage value that indicates the packed size of the session policies and session - tags combined passed in the request. The request fails if the packed size is greater - than 100 percent, which means the policies and tags exceeded the allowed space. - - - - - - Gets and sets the property SourceIdentity. - - The value in the SourceIdentity attribute in the SAML assertion. - - - - You can require users to set a source identity value when they assume a role. You - do this by using the sts:SourceIdentity condition key in a role trust - policy. That way, actions that are taken with the role are associated with that user. - After the source identity is set, the value cannot be changed. It is present in the - request for all actions that are taken by the role and persists across chained - role sessions. You can configure your SAML identity provider to use an attribute - associated with your users, like user name or email, as the source identity when calling - AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. - For more information about using source identity, see Monitor - and control actions taken with assumed roles in the IAM User Guide. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property Subject. - - The value of the NameID element in the Subject element of - the SAML assertion. - - - - - - Gets and sets the property SubjectType. - - The format of the name ID, as defined by the Format attribute in the - NameID element of the SAML assertion. Typical examples of the format - are transient or persistent. - - - - If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, - that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient - is returned as transient. If the format includes any other prefix, the - format is returned with no modifications. - - - - - - Container for the parameters to the AssumeRoleWithWebIdentity operation. - Returns a set of temporary security credentials for users who have been authenticated - in a mobile or web application with a web identity provider. Example providers include - Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible - identity provider. - - - - For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon - Cognito with the AWS SDK for iOS Developer - Guide and the AWS SDK for Android - Developer Guide to uniquely identify a user. You can also supply the user with - a consistent identity throughout the lifetime of an application. - - - - To learn more about Amazon Cognito, see Amazon - Cognito Overview in AWS SDK for Android Developer Guide and Amazon - Cognito Overview in the AWS SDK for iOS Developer Guide. - - - - Calling AssumeRoleWithWebIdentity does not require the use of AWS security - credentials. Therefore, you can distribute an application (for example, on mobile - devices) that requests temporary security credentials without including long-term - AWS credentials in the application. You also don't need to deploy server-based proxy - services that use long-term AWS credentials. Instead, the identity of the caller is - validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - The temporary security credentials returned by this API consist of an access key ID, - a secret access key, and a security token. Applications can use these temporary security - credentials to sign calls to AWS service API operations. - - - - Session Duration - - - - By default, the temporary security credentials created by AssumeRoleWithWebIdentity - last for one hour. However, you can use the optional DurationSeconds - parameter to specify the duration of your session. You can provide a value from 900 - seconds (15 minutes) up to the maximum session duration setting for the role. This - setting can have a value from 1 hour to 12 hours. To learn how to view the maximum - value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - The maximum session duration limit applies when you use the AssumeRole* - API operations or the assume-role* CLI commands. However the limit does - not apply when you use those operations to create a console URL. For more information, - see Using - IAM Roles in the IAM User Guide. - - - - Permissions - - - - The temporary security credentials created by AssumeRoleWithWebIdentity - can be used to make API calls to any AWS service with the following exception: you - cannot call the STS GetFederationToken or GetSessionToken - API operations. - - - - (Optional) You can pass inline or managed session - policies to this operation. You can pass a single JSON policy document to use - as an inline session policy. You can also specify up to 10 managed policies to use - as managed session policies. The plaintext that you use for both inline and managed - session policies can't exceed 2,048 characters. Passing policies to this operation - returns new temporary credentials. The resulting session's permissions are the intersection - of the role's identity-based policy and the session policies. You can use the role's - temporary credentials in subsequent AWS API calls to access resources in the account - that owns the role. You cannot use session policies to grant more permissions than - those allowed by the identity-based policy of the role that is being assumed. For - more information, see Session - Policies in the IAM User Guide. - - - - Tags - - - - (Optional) You can configure your IdP to pass attributes into your web identity token - as session tags. Each session tag consists of a key name and an associated value. - For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - characters and the values can’t exceed 256 characters. For these and additional limits, - see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is attached to the role. - When you do, the session tag overrides the role tag with the same key. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - You can set the session tags as transitive. Transitive tags persist during role chaining. - For more information, see Chaining - Roles with Session Tags in the IAM User Guide. - - - - Identities - - - - Before your application can call AssumeRoleWithWebIdentity, you must - have an identity token from a supported identity provider and create a role that the - application can assume. The role that your application assumes must trust the identity - provider that is associated with the identity token. In other words, the identity - provider must be specified in the role's trust policy. - - - - Calling AssumeRoleWithWebIdentity can result in an entry in your AWS - CloudTrail logs. The entry includes the Subject - of the provided web identity token. We recommend that you avoid using any personally - identifiable information (PII) in this field. For example, you could instead use a - GUID or a pairwise identifier, as suggested - in the OIDC specification. - - - - For more information about how to use web identity federation and the AssumeRoleWithWebIdentity - API, see the following resources: - - - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. The JSON policy characters can be any ASCII character from the space - character to the end of the valid character list (\u0020 through \u00FF). It can also - include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property RoleArn. - - The Amazon Resource Name (ARN) of the role that the caller is assuming. - - - - - - Gets and sets the property RoleSessionName. - - An identifier for the assumed role session. Typically, you pass the name or identifier - that is associated with the user who is using your application. That way, the temporary - security credentials that your application will use are associated with that user. - This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser - response element. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property WebIdentityToken. - - The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity - provider. Your application must get this token by authenticating the user who is using - your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity - call. - - - - - - Contains the response to a successful AssumeRoleWithWebIdentity request, including - temporary AWS credentials that can be used to make AWS requests. - - - - - Gets and sets the property AssumedRoleUser. - - The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that - you can use to refer to the resulting temporary security credentials. For example, - you can reference these credentials as a principal in a resource-based policy by using - the ARN or assumed role ID. The ARN and ID include the RoleSessionName - that you specified when you called AssumeRole. - - - - - - Gets and sets the property Audience. - - The intended audience (also known as client ID) of the web identity token. This is - traditionally the client identifier issued to the application that requested the web - identity token. - - - - - - Gets and sets the property Credentials. - - The temporary security credentials, which include an access key ID, a secret access - key, and a security token. - - - - The size of the security token that STS API operations return is not fixed. We strongly - recommend that you make no assumptions about the maximum size. - - - - - - - Gets and sets the property PackedPolicySize. - - A percentage value that indicates the packed size of the session policies and session - tags combined passed in the request. The request fails if the packed size is greater - than 100 percent, which means the policies and tags exceeded the allowed space. - - - - - - Gets and sets the property Provider. - - The issuing authority of the web identity token presented. For OpenID Connect ID - tokens, this contains the value of the iss field. For OAuth 2.0 access - tokens, this contains the value of the ProviderId parameter that was - passed in the AssumeRoleWithWebIdentity request. - - - - - - Gets and sets the property SourceIdentity. - - The value of the source identity that is returned in the JSON web token (JWT) from - the identity provider. - - - - You can require users to set a source identity value when they assume a role. You - do this by using the sts:SourceIdentity condition key in a role trust - policy. That way, actions that are taken with the role are associated with that user. - After the source identity is set, the value cannot be changed. It is present in the - request for all actions that are taken by the role and persists across chained - role sessions. You can configure your identity provider to use an attribute associated - with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. - You do this by adding a claim to the JSON web token. To learn more about OIDC tokens - and claims, see Using - Tokens with User Pools in the Amazon Cognito Developer Guide. For more - information about using source identity, see Monitor - and control actions taken with assumed roles in the IAM User Guide. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property SubjectFromWebIdentityToken. - - The unique user identifier that is returned by the identity provider. This identifier - is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity - call. The identifier is typically unique to the user and the application that acquired - the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, - this field contains the value returned by the identity provider as the token's sub - (Subject) claim. - - - - - - Container for the parameters to the DecodeAuthorizationMessage operation. - Decodes additional information about the authorization status of a request from an - encoded message returned in response to an AWS request. - - - - For example, if a user is not authorized to perform an operation that he or she has - requested, the request returns a Client.UnauthorizedOperation response - (an HTTP 403 response). Some AWS operations additionally return an encoded message - that can provide details about this authorization failure. - - - - Only certain AWS operations return an encoded authorization message. The documentation - for an individual operation indicates whether that operation returns an encoded message - in addition to returning an HTTP code. - - - - The message is encoded because the details of the authorization status can constitute - privileged information that the user who requested the operation should not see. To - decode an authorization status message, a user must be granted permissions via an - IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) - action. - - - - The decoded message includes the following type of information: - -
  • - - Whether the request was denied due to an explicit deny or due to the absence of an - explicit allow. For more information, see Determining - Whether a Request is Allowed or Denied in the IAM User Guide. - -
  • - - The principal who made the request. - -
  • - - The requested action. - -
  • - - The requested resource. - -
  • - - The values of condition keys in the context of the user's request. - -
- - - - - Gets and sets the property EncodedMessage. - - The encoded message that was returned with the response. - - - - - - A document that contains additional information about the authorization status of - a request from an encoded message that is returned in response to an AWS request. - - - - - Gets and sets the property DecodedMessage. - - An XML document that contains the decoded message. - - - - - - The web identity token that was passed is expired or is not valid. Get a new identity - token from the identity provider and then retry the request. - - - - - Constructs a new ExpiredTokenException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of ExpiredTokenException - - - - - - - Construct instance of ExpiredTokenException - - - - - - Construct instance of ExpiredTokenException - - - - - - - - - - - Construct instance of ExpiredTokenException - - - - - - - - - - Constructs a new instance of the ExpiredTokenException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Identifiers for the federated user that is associated with the credentials. - - - - - Empty constructor used to set properties independently even when a simple constructor is available - - - - - Instantiates FederatedUser with the parameterized properties - - The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user. - The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide. - - - - Gets and sets the property Arn. - - The ARN that specifies the federated user that is associated with the credentials. - For more information about ARNs and how to use them in policies, see IAM - Identifiers in the IAM User Guide. - - - - - - Gets and sets the property FederatedUserId. - - The string that identifies the federated user associated with the credentials, similar - to the unique ID of an IAM user. - - - - - - Container for the parameters to the GetAccessKeyInfo operation. - Returns the account identifier for the specified access key ID. - - - - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) - and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). - For more information about access keys, see Managing - Access Keys for IAM Users in the IAM User Guide. - - - - When you pass an access key ID to this operation, it returns the ID of the AWS account - to which the keys belong. Access key IDs beginning with AKIA are long-term - credentials for an IAM user or the AWS account root user. Access key IDs beginning - with ASIA are temporary credentials that are created using STS operations. - If the account in the response belongs to you, you can sign in as the root user and - review your root user access keys. Then, you can pull a credentials - report to learn which IAM user owns the keys. To learn who requested the temporary - credentials for an ASIA access key, view the STS events in your CloudTrail - logs in the IAM User Guide. - - - - This operation does not indicate the state of the access key. The key might be active, - inactive, or deleted. Active keys might not have permissions to perform an operation. - Providing a deleted access key might return an error that the key doesn't exist. - - - - - - Gets and sets the property AccessKeyId. - - The identifier of an access key. - - - - This parameter allows (through its regex pattern) a string of characters that can - consist of any upper- or lowercase letter or digit. - - - - - - This is the response object from the GetAccessKeyInfo operation. - - - - - Gets and sets the property Account. - - The number used to identify the AWS account. - - - - - - Container for the parameters to the GetCallerIdentity operation. - Returns details about the IAM user or role whose credentials are used to call the - operation. - - - - No permissions are required to perform this operation. If an administrator adds a - policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity - action, you can still perform this operation. Permissions are not required because - the same information is returned when an IAM user or role is denied access. To view - an example response, see I - Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. - - - - - - - Contains the response to a successful GetCallerIdentity request, including - information about the entity making the request. - - - - - Gets and sets the property Account. - - The AWS account ID number of the account that owns or contains the calling entity. - - - - - - Gets and sets the property Arn. - - The AWS ARN associated with the calling entity. - - - - - - Gets and sets the property UserId. - - The unique identifier of the calling entity. The exact value depends on the type of - entity that is making the call. The values returned are those listed in the aws:userid - column in the Principal - table found on the Policy Variables reference page in the IAM User Guide. - - - - - - Container for the parameters to the GetFederationToken operation. - Returns a set of temporary security credentials (consisting of an access key ID, a - secret access key, and a security token) for a federated user. A typical use is in - a proxy application that gets temporary security credentials on behalf of distributed - applications inside a corporate network. You must call the GetFederationToken - operation using the long-term security credentials of an IAM user. As a result, this - call is appropriate in contexts where those credentials can be safely stored, usually - in a server-based application. For a comparison of GetFederationToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - You can create a mobile-based or browser-based app that can authenticate users using - a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible - identity provider. In this case, we recommend that you use Amazon - Cognito or AssumeRoleWithWebIdentity. For more information, see Federation - Through a Web-based Identity Provider in the IAM User Guide. - - - - You can also call GetFederationToken using the security credentials of - an AWS account root user, but we do not recommend it. Instead, we recommend that you - create an IAM user for the purpose of the proxy application. Then attach a policy - to the IAM user that limits federated users to only the actions and resources that - they need to access. For more information, see IAM - Best Practices in the IAM User Guide. - - - - Session duration - - - - The temporary credentials are valid for the specified duration, from 900 seconds (15 - minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration - is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS - account root user credentials have a maximum duration of 3,600 seconds (1 hour). - - - - Permissions - - - - You can use the temporary credentials created by GetFederationToken in - any AWS service except the following: - -
  • - - You cannot call any IAM operations using the AWS CLI or the AWS API. - -
  • - - You cannot call any STS operations except GetCallerIdentity. - -
- - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plain text that you use for both inline and managed - session policies can't exceed 2,048 characters. - - - - Though the session policy parameters are optional, if you do not pass a policy, then - the resulting federated user session has no permissions. When you pass session policies, - the session permissions are the intersection of the IAM user policies and the session - policies that you pass. This gives you a way to further restrict the permissions for - a federated user. You cannot use session policies to grant more permissions than those - that are defined in the permissions policy of the IAM user. For more information, - see Session - Policies in the IAM User Guide. For information about using GetFederationToken - to create temporary security credentials, see GetFederationToken—Federation - Through a Custom Identity Broker. - - - - You can use the credentials to access a resource that has a resource-based policy. - If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions granted by the session policies. - - - - Tags - - - - (Optional) You can pass tag key-value pairs to your session. These are called session - tags. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - An administrator must grant you the permissions necessary to pass session tags. The - administrator can also create granular permissions to allow you to pass only specific - session tags. For more information, see Tutorial: - Using Tags for Attribute-Based Access Control in the IAM User Guide. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the user that you are federating has the Department=Marketing - tag and you pass the department=engineering session tag. - Department and department are not saved as separate tags, - and the session tag passed in the request takes precedence over the user tag. - - - - - - Empty constructor used to set properties independently even when a simple constructor is available - - - - - Instantiates GetFederationTokenRequest with the parameterized properties - - The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, that the session should last. Acceptable durations for federation - sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 - seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials - are restricted to a maximum of 3,600 seconds (one hour). If the specified duration - is longer than one hour, the session obtained by using root user credentials defaults - to one hour. - - - - - - Gets and sets the property Name. - - The name of the federated user. The name is used as an identifier for the temporary - security credentials (such as Bob). For example, you can reference the - federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. - - - - This parameter is optional. However, if you do not pass any session policies, then - the resulting federated user session has no permissions. - - - - When you pass session policies, the session permissions are the intersection of the - IAM user policies and the session policies that you pass. This gives you a way to - further restrict the permissions for a federated user. You cannot use session policies - to grant more permissions than those that are defined in the permissions policy of - the IAM user. For more information, see Session - Policies in the IAM User Guide. - - - - The resulting credentials can be used to access a resource that has a resource-based - policy. If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions that are granted by the session - policies. - - - - The plaintext that you use for both inline and managed session policies can't exceed - 2,048 characters. The JSON policy characters can be any ASCII character from the space - character to the end of the valid character list (\u0020 through \u00FF). It can also - include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as a managed session policy. The policies must exist in the same account as the IAM - user that is requesting federated access. - - - - You must pass an inline or managed session - policy to this operation. You can pass a single JSON policy document to use as - an inline session policy. You can also specify up to 10 managed policies to use as - managed session policies. The plaintext that you use for both inline and managed session - policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. - For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - This parameter is optional. However, if you do not pass any session policies, then - the resulting federated user session has no permissions. - - - - When you pass session policies, the session permissions are the intersection of the - IAM user policies and the session policies that you pass. This gives you a way to - further restrict the permissions for a federated user. You cannot use session policies - to grant more permissions than those that are defined in the permissions policy of - the IAM user. For more information, see Session - Policies in the IAM User Guide. - - - - The resulting credentials can be used to access a resource that has a resource-based - policy. If that policy specifically references the federated user session in the Principal - element of the policy, the session has the permissions allowed by the policy. These - permissions are granted in addition to the permissions that are granted by the session - policies. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - - - - Gets and sets the property Tags. - - A list of session tags. Each session tag consists of a key name and an associated - value. For more information about session tags, see Passing - Session Tags in STS in the IAM User Guide. - - - - This parameter is optional. You can pass up to 50 session tags. The plaintext session - tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For - these and additional limits, see IAM - and STS Character Limits in the IAM User Guide. - - - - An AWS conversion compresses the passed session policies and session tags into a packed - binary format that has a separate limit. Your request can fail for this limit even - if your plaintext meets the other requirements. The PackedPolicySize - response element indicates by percentage how close the policies and tags for your - request are to the upper size limit. - - - - You can pass a session tag with the same key as a tag that is already attached to - the user you are federating. When you do, session tags override a user tag with the - same key. - - - - Tag key–value pairs are not case sensitive, but case is preserved. This means that - you cannot have separate Department and department tag keys. - Assume that the role has the Department=Marketing tag and - you pass the department=engineering session tag. Department - and department are not saved as separate tags, and the session tag passed - in the request takes precedence over the role tag. - - - - - - Contains the response to a successful GetFederationToken request, including - temporary AWS credentials that can be used to make AWS requests. - - - - - Gets and sets the property Credentials. - - The temporary security credentials, which include an access key ID, a secret access - key, and a security (or session) token. - - - - The size of the security token that STS API operations return is not fixed. We strongly - recommend that you make no assumptions about the maximum size. - - - - - - - Gets and sets the property FederatedUser. - - Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob - or 123456789012:Bob). You can use the federated user's ARN in your resource-based - policies, such as an Amazon S3 bucket policy. - - - - - - Gets and sets the property PackedPolicySize. - - A percentage value that indicates the packed size of the session policies and session - tags combined passed in the request. The request fails if the packed size is greater - than 100 percent, which means the policies and tags exceeded the allowed space. - - - - - - Container for the parameters to the GetSessionToken operation. - Returns a set of temporary credentials for an AWS account or IAM user. The credentials - consist of an access key ID, a secret access key, and a security token. Typically, - you use GetSessionToken if you want to use MFA to protect programmatic - calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled - IAM users would need to call GetSessionToken and submit an MFA code that - is associated with their MFA device. Using the temporary security credentials that - are returned from the call, IAM users can then make programmatic calls to API operations - that require MFA authentication. If you do not supply a correct MFA code, then the - API returns an access denied error. For a comparison of GetSessionToken - with the other API operations that produce temporary credentials, see Requesting - Temporary Security Credentials and Comparing - the AWS STS API operations in the IAM User Guide. - - - - Session Duration - - - - The GetSessionToken operation must be called by using the long-term AWS - security credentials of the AWS account root user or an IAM user. Credentials that - are created by IAM users are valid for the duration that you specify. This duration - can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), - with a default of 43,200 seconds (12 hours). Credentials based on account credentials - can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default - of 1 hour. - - - - Permissions - - - - The temporary security credentials created by GetSessionToken can be - used to make API calls to any AWS service with the following exceptions: - -
  • - - You cannot call any IAM API operations unless MFA authentication information is included - in the request. - -
  • - - You cannot call any STS API except AssumeRole or GetCallerIdentity. - -
- - We recommend that you do not call GetSessionToken with AWS account root - user credentials. Instead, follow our best - practices by creating one or more IAM users, giving them the necessary permissions, - and using IAM users for everyday interaction with AWS. - - - - The credentials that are returned by GetSessionToken are based on permissions - associated with the user whose credentials were used to call the operation. If GetSessionToken - is called using AWS account root user credentials, the temporary credentials have - root user permissions. Similarly, if GetSessionToken is called using - the credentials of an IAM user, the temporary credentials have the same permissions - as the IAM user. - - - - For more information about using GetSessionToken to create temporary - credentials, go to Temporary - Credentials for Users in Untrusted Environments in the IAM User Guide. - - - - - - - Empty constructor used to set properties independently even when a simple constructor is available - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, that the credentials should remain valid. Acceptable durations - for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), - with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are - restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than - one hour, the session for AWS account owners defaults to one hour. - - - - - - Gets and sets the property SerialNumber. - - The identification number of the MFA device that is associated with the IAM user who - is making the GetSessionToken call. Specify this value if the IAM user - has a policy that requires MFA authentication. The value is either the serial number - for a hardware device (such as GAHT12345678) or an Amazon Resource Name - (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). - You can find the device for an IAM user by going to the AWS Management Console and - viewing the user's security credentials. - - - - The regex used to validate this parameter is a string of characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@:/- - - - - - - Gets and sets the property TokenCode. - - The value provided by the MFA device, if MFA is required. If any policy requires the - IAM user to submit an MFA code, specify this value. If MFA authentication is required, - the user must provide a code when requesting a set of temporary security credentials. - A user who fails to provide the code receives an "access denied" response when requesting - resources that require MFA authentication. - - - - The format for this parameter, as described by its regex pattern, is a sequence of - six numeric digits. - - - - - - Contains the response to a successful GetSessionToken request, including temporary - AWS credentials that can be used to make AWS requests. - - - - - Gets and sets the property Credentials. - - The temporary security credentials, which include an access key ID, a secret access - key, and a security (or session) token. - - - - The size of the security token that STS API operations return is not fixed. We strongly - recommend that you make no assumptions about the maximum size. - - - - - - - The request could not be fulfilled because the identity provider (IDP) that was asked - to verify the incoming identity token could not be reached. This is often a transient - error caused by network conditions. Retry the request a limited number of times so - that you don't exceed the request rate. If the error persists, the identity provider - might be down or not responding. - - - - - Constructs a new IDPCommunicationErrorException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of IDPCommunicationErrorException - - - - - - - Construct instance of IDPCommunicationErrorException - - - - - - Construct instance of IDPCommunicationErrorException - - - - - - - - - - - Construct instance of IDPCommunicationErrorException - - - - - - - - - - Constructs a new instance of the IDPCommunicationErrorException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The identity provider (IdP) reported that authentication failed. This might be because - the claim is invalid. - - - - If this error is returned for the AssumeRoleWithWebIdentity operation, - it can also mean that the claim has expired or has been explicitly revoked. - - - - - - Constructs a new IDPRejectedClaimException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of IDPRejectedClaimException - - - - - - - Construct instance of IDPRejectedClaimException - - - - - - Construct instance of IDPRejectedClaimException - - - - - - - - - - - Construct instance of IDPRejectedClaimException - - - - - - - - - - Constructs a new instance of the IDPRejectedClaimException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Response Unmarshaller for AssumedRoleUser Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - AssumeRole Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AssumeRole operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AssumeRoleWithSAML Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AssumeRoleWithSAML operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - AssumeRoleWithWebIdentity Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for AssumeRoleWithWebIdentity operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for Credentials Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - DecodeAuthorizationMessage Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for DecodeAuthorizationMessage operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for ExpiredTokenException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for FederatedUser Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - Gets the singleton. - - - - - GetAccessKeyInfo Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetAccessKeyInfo operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetCallerIdentity Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetCallerIdentity operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetFederationToken Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetFederationToken operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - GetSessionToken Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for GetSessionToken operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for IDPCommunicationErrorException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for IDPRejectedClaimException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidAuthorizationMessageException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for InvalidIdentityTokenException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for MalformedPolicyDocumentException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for PackedPolicyTooLargeException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - Response Unmarshaller for RegionDisabledException operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Unmarshaller error response to exception. - - - - - - - - Gets the singleton. - - - - - The error returned if the message passed to DecodeAuthorizationMessage - was invalid. This can happen if the token contains invalid characters, such as linebreaks. - - - - - Constructs a new InvalidAuthorizationMessageException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidAuthorizationMessageException - - - - - - - Construct instance of InvalidAuthorizationMessageException - - - - - - Construct instance of InvalidAuthorizationMessageException - - - - - - - - - - - Construct instance of InvalidAuthorizationMessageException - - - - - - - - - - Constructs a new instance of the InvalidAuthorizationMessageException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The web identity token that was passed could not be validated by AWS. Get a new identity - token from the identity provider and then retry the request. - - - - - Constructs a new InvalidIdentityTokenException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of InvalidIdentityTokenException - - - - - - - Construct instance of InvalidIdentityTokenException - - - - - - Construct instance of InvalidIdentityTokenException - - - - - - - - - - - Construct instance of InvalidIdentityTokenException - - - - - - - - - - Constructs a new instance of the InvalidIdentityTokenException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The request was rejected because the policy document was malformed. The error message - describes the specific error. - - - - - Constructs a new MalformedPolicyDocumentException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of MalformedPolicyDocumentException - - - - - - - Construct instance of MalformedPolicyDocumentException - - - - - - Construct instance of MalformedPolicyDocumentException - - - - - - - - - - - Construct instance of MalformedPolicyDocumentException - - - - - - - - - - Constructs a new instance of the MalformedPolicyDocumentException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The request was rejected because the total packed size of the session policies and - session tags combined was too large. An AWS conversion compresses the session policy - document, session policy ARNs, and session tags into a packed binary format that has - a separate limit. The error message indicates by percentage how close the policies - and tags are to the upper size limit. For more information, see Passing - Session Tags in STS in the IAM User Guide. - - - - You could receive this error even though you meet other defined session policy and - session tag limits. For more information, see IAM - and STS Entity Character Limits in the IAM User Guide. - - - - - - Constructs a new PackedPolicyTooLargeException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of PackedPolicyTooLargeException - - - - - - - Construct instance of PackedPolicyTooLargeException - - - - - - Construct instance of PackedPolicyTooLargeException - - - - - - - - - - - Construct instance of PackedPolicyTooLargeException - - - - - - - - - - Constructs a new instance of the PackedPolicyTooLargeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A reference to the IAM managed policy that is passed as a session policy for a role - session or a federated user session. - - - - - Gets and sets the property Arn. - - The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy - for the role. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - - - STS is not activated in the requested region for the account that is being asked to - generate credentials. The account administrator must use the IAM console to activate - STS in that region. For more information, see Activating - and Deactivating AWS STS in an AWS Region in the IAM User Guide. - - - - - Constructs a new RegionDisabledException with the specified error - message. - - - Describes the error encountered. - - - - - Construct instance of RegionDisabledException - - - - - - - Construct instance of RegionDisabledException - - - - - - Construct instance of RegionDisabledException - - - - - - - - - - - Construct instance of RegionDisabledException - - - - - - - - - - Constructs a new instance of the RegionDisabledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - You can pass custom key-value pair attributes when you assume a role or federate a - user. These are called session tags. You can then use the session tags to control - access to resources. For more information, see Tagging - AWS STS Sessions in the IAM User Guide. - - - - - Gets and sets the property Key. - - The key for a session tag. - - - - You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 - characters. For these and additional limits, see IAM - and STS Character Limits in the IAM User Guide. - - - - - - Gets and sets the property Value. - - The value for a session tag. - - - - You can pass up to 50 session tags. The plain text session tag values can’t exceed - 256 characters. For these and additional limits, see IAM - and STS Character Limits in the IAM User Guide. - - - - - - Implementation of IAuthenticationController, allowing authentication calls against - an AD FS endpoint. - - - - - Authenticates the user with the specified AD FS endpoint and - yields the SAML response data for subsequent parsing. - - - The https endpoint of the federated identity provider. - - - Credentials for the call. If null, the user's default network credentials - will be used in a temporary impersonation context. - - - The authentication type to be used with the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. - - Null or configured proxy settings for the HTTPS call. - The response data from a successful authentication request. - - - - Custom exception thrown when authentication failure is detected against - a configured AD FS endpoint. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the AdfsAuthenticationControllerException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Implementation of IAuthenticationResponseParser, allowing parsing of the responses for - successful authentication calls against AD FS endpoints. - - - - - Parses the authentication response (html) and extracts the SAML response (xml) - for further parsing. - - - The HTML response data from the successful authentication call. - - - Assertion instance containing the data needed to support credential generation. - - - - - Contains the parsed SAML response data following successful user - authentication against a federated endpoint. We only parse out the - data we need to support generation of temporary AWS credentials. - - - - - The full SAML assertion parsed from the identity provider's - response. - - - - - The collection of roles available to the authenticated user. - he parsed friendly role name is used to key the entries. - - - - - Retrieves a set of temporary credentials for the specified role, valid for the specified timespan. - If the SAML authentication data yield more than one role, a valid role name must be specified. - - The STS client to use when making the AssumeRoleWithSAML request. - - The arns of the principal and role as returned in the SAML assertion. - - The valid timespan for the credentials. - Temporary session credentials for the specified or default role for the user. - - - - Constructs a new SAML assertion wrapper based on a successful authentication - response and extracts the role data contained in the assertion. - - - - - - Parses the role data out of the assertion using xpath queries. We additionally - parse the role ARNs to extract friendly role names that can be used in UI - prompts in tooling. - - Dictionary of friendly role names to role arn mappings. - - - - Interface implemented by plugins supplied to the SAMLAuthenticationController - to perform the call to the authentication endpoint. The implementor returns the - final response from the authentication process for subsequent parsing. - - - - - Calls the specified endpoint, optionally providing custom credentials. - - The endpoint providing - - Optional, if not supplied the token for the currently logged-in user is supplied to the authentication endpoint. - - - The authentication type expected by the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. - - Null or configured proxy settings for the HTTPS call. - The raw response data from the authentication request. - - - - Interface implemented by plugins supplied to the SAMLAuthenticationController - to parse an authentication response returned by an IAuthenticator instance and - yield a SAMLAssertion instance. - - - - - Parses the supplied reponse data to instantiate a SAMLAssertion instance - containing IAM role and token data that can be used to generate temporary - AWS credentials. - - - The response that was returned from user authentication. - - SAMLAssertion instance corresponding to the response data. - - - - Helper class to perform SAML authentication negotiation for an identity - provider and relying party combination. Yields a SAMLAssertion instance - that can be used to retrieve temporary, auto-refreshing AWS credentials. - - - - - Handler that will be called to perform the authentication process to a - defined endpoint. - - - - - Handler that will be called to parse the response from a succesful - authentication request. - - - - - Proxy details if required for communication with the authentication endpoint. - - - - - Instantiates a controller instance configured to use the built-in AD FS - classes to authenticate and parse the responses. - - - - - Instantiates a controller instance configured to use the built-in AD FS - classes to authenticate and parse the responses. The supplied proxy settings will - be used in the HTTPS calls to the authentication endpoint. - - - - - Instantiates the controller to use the specified instances to perform authentication - and response parsing. - - - Handler that will be called to perform authentication. - - - Handler that will be called to parse successful authentication responses - - - Null or proxy settings that should be used when communicating with the authentication endpoint. - - - - - Authenticates the specified network credentials with a provider endpoint and - returns the SAML assertion data from which temporary AWS credentials can be obtained. - - The authentication endpoint to be called. - - Credentials for the call. If null, the users default network credentials will be used - in a temporary impersonation context. - - - The authentication type expected by the endpoint. The default value if not specified - is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. - - SAMLAssertion instance wrapping the returned document on successful authentication. - - - - Authenticates the specified network credentials with a provider endpoint and - returns the SAML assertion data from which temporary AWS credentials can be obtained. - - The authentication endpoint to be called. - - Credentials for the call. If null, the users default network credentials will be used - in a temporary impersonation context. - - - The authentication type expected by the endpoint. The default value if not specified - is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. - - SAMLAssertion instance wrapping the returned document on successful authentication. - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. - - - - - Any custom state passed when a credential callback was registered. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Callback signature for obtaining user credentials for authentication demands when - the role profile is configured to not use the default identity. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Registered callback for obtaining credentials to use in authentication. - Required to be set if the role profile is not configured to use the default - identity. - - - - - Constructs an instance of StoredProfileSAMLCredentials. This constructor searches for details - of the role to assume, and optional credentials to use with the endpoint, using the - profile name specified in the App.config. - - - - - - Constructs an instance of StoredProfileSAMLCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - The ini-format credentials file is not currently supported. - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - If non-default credentials are to be used for authentication, - validates that the authentication required callback has been - populated. - - - - - Refresh credentials after expiry. If the role profile is configured to not - use the default user identity, an exception is thrown if the UserAuthenticationCallback - property has not been set. - - - - - - State class passed on callback to demand user credentials when authentication - is performed using a non-default identity. - - - - - Contains the user identity that the user should supply a password - for. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - Exception thrown on validation of a StoredProfileSAMLCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the AdfsAuthenticationControllerException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user against the - configured endpoint fails and a valid SAML assertion document could not be - obtained. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the AuthenticationFailedException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - An implementation of the that retries certain additional - STS errors when doing AssumeRoleWithWebIdentity requests. - - - - - Constructor for SecurityTokenServiceRetryPolicy. - - - - - Returns true if the request should be retried. - - - - - Returns true if the request should be retried. - - - - - An implementation of the that retries certain additional - STS errors when doing AssumeRoleWithWebIdentity requests. - - - - - Constructor for SecurityTokenServiceStandardRetryPolicy. - - - - - Returns true if the request should be retried. - - - - - Returns true if the request should be retried. - - - - - An implementation of the that retries certain additional - STS errors when doing AssumeRoleWithWebIdentity requests. - - - - - Constructor for SecurityTokenServiceAdaptiveRetryPolicy. - - - - - Returns true if the request should be retried. - - - - - Returns true if the request should be retried. - - - - - Common exception for the SecurityTokenService service. - - - - - Construct instance of AmazonSecurityTokenServiceException - - - - - - Construct instance of AmazonSecurityTokenServiceException - - - - - - - Construct instance of AmazonSecurityTokenServiceException - - - - - - Construct instance of AmazonSecurityTokenServiceException - - - - - - - - - - Construct instance of AmazonSecurityTokenServiceException - - - - - - - - - - - Constructs a new instance of the AmazonSecurityTokenServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Service metadata for Amazon SecurityTokenService service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Base class for SecurityTokenService operation requests. - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml.meta deleted file mode 100644 index 6f202a12..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.SecurityToken.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: a2f2d73d2c4364c499fb8e7e3c88f338 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AmazonGameLiftPlugin.Core.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AmazonGameLiftPlugin.Core.dll.meta deleted file mode 100644 index bcb9090e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AmazonGameLiftPlugin.Core.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 037b677f0ee6fa645bbefb89705b51b1 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 0 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK.meta deleted file mode 100644 index 428d68b2..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: 8ff608bf4d17b044aa3f602c30e8d160 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config deleted file mode 100644 index 3dbff35f..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config.meta deleted file mode 100644 index b8824454..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.config.meta +++ /dev/null @@ -1,92 +0,0 @@ -fileFormatVersion: 2 -guid: 20f844591636a144583795e1007b98dd -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 0 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 1 - settings: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.meta deleted file mode 100644 index 82d9848e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/GameLiftServerSDKNet45.dll.meta +++ /dev/null @@ -1,96 +0,0 @@ -fileFormatVersion: 2 -guid: b8e760613e725054ab57520106122960 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 0 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.dll.meta deleted file mode 100644 index 02b63bf7..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: 2a089be0a58a54d4f82c394cadd3f366 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.dll.meta deleted file mode 100644 index a90ff0e9..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: a7d0a70312839b34d9d18db2a26f92b1 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.dll.meta deleted file mode 100644 index d30421c0..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: 168f90ced2c3515478008523a1d137a1 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.dll.meta deleted file mode 100644 index 10dc4bb4..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: 24e6d2dddbcc79e49b227348ec2d345f -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.dll.meta deleted file mode 100644 index 9c7664d5..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: ac0cf2cbe1a32bf4abf18bb2f38bbf9c -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.dll.meta deleted file mode 100644 index eba2c6e0..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: 57ced5d5c34b2904d95c0f4e655b094c -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/websocket-sharp.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/websocket-sharp.dll.meta deleted file mode 100644 index df27e24c..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/websocket-sharp.dll.meta +++ /dev/null @@ -1,94 +0,0 @@ -fileFormatVersion: 2 -guid: 0070320b6b3221145b3f4bfc2e4f1cdd -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - UNITY_SERVER - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 0 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta deleted file mode 100644 index c6a9b83e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: c63ea243a89c5ed4aae58a61affea72d -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 1 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml deleted file mode 100644 index bc1fa266..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml +++ /dev/null @@ -1,1023 +0,0 @@ - - - - Microsoft.IdentityModel.JsonWebTokens - - - - - Constants for Json Web tokens. - - - - - A URI that represents the JSON XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON array XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON null data type - - When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull - - - - A designed for representing a JSON Web Token (JWT). - - - - - Initializes a new instance of from a string in JWS or JWE Compact serialized format. - - A JSON Web Token that has been serialized in JWS or JWE Compact serialized format. - 'jwtEncodedString' is null or empty. - 'jwtEncodedString' is not in JWS or JWE Compact serialization format. - - The contents of the returned have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using the validation methods in - - - - - Initializes a new instance of the class where the header contains the crypto algorithms applied to the encoded header and payload. - - A string containing JSON which represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT. - A string containing JSON which represents the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }. - 'header' is null. - 'payload' is null. - - - - Gets the 'value' of the 'actort' claim { actort, 'value' }. - - If the 'actort' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'alg' claim { alg, 'value' }. - - If the 'alg' claim is not found, an empty string is returned. - - - - Gets the list of 'aud' claim { aud, 'value' }. - - If the 'aud' claim is not found, enumeration will be empty. - - - - Gets the AuthenticationTag from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets the Ciphertext from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets a for each JSON { name, value }. - - - - - Gets the 'value' of the 'cty' claim { cty, 'value' }. - - If the 'cty' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'enc' claim { enc, 'value' }. - - If the 'enc' value is not found, an empty string is returned. - - - - Gets the EncryptedKey from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT. - - - - - Gets the 'value' of the 'jti' claim { jti, ''value' }. - - If the 'jti' claim is not found, an empty string is returned. - - - - Gets the InitializationVector from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets the associated with this instance. - - - - - Gets the 'value' of the 'iat' claim { iat, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'iat' claim is not found, then is returned. - - - - Gets the 'value' of the 'iss' claim { iss, 'value' }. - - If the 'iss' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'kid' claim { kid, 'value' }. - - If the 'kid' claim is not found, an empty string is returned. - - - - Represents the JSON payload. - - - - - Gets the EncodedHeader from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets the EncodedPayload from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets the EncodedSignature from the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed into the constructor. - - - - Gets the original raw data of this instance when it was created. - - - - - Not implemented. - - - - - Not implemented. - - - - - Gets the 'value' of the 'sub' claim { sub, 'value' }. - - If the 'sub' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'typ' claim { typ, 'value' }. - - If the 'typ' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'nbf' claim { nbf, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'nbf' claim is not found, then is returned. - - - - Gets the 'value' of the 'exp' claim { exp, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'exp' claim is not found, then is returned. - - - - Gets the 'value' of the 'x5t' claim { x5t, 'value' }. - - If the 'x5t' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'zip' claim { zip, 'value' }. - - If the 'zip' claim is not found, an empty string is returned. - - - - Decodes the string into the header, payload and signature. - - the tokenized string. - the original token. - - - - Decodes the payload and signature from the JWE parts. - - Parts of the JWE including the header. - - Assumes Header has already been set. - According to the JWE documentation (https://tools.ietf.org/html/rfc7516#section-2), it is possible for the EncryptedKey, InitializationVector, and AuthenticationTag to be empty strings. - - - - - Decodes the payload and signature from the JWS parts. - - Parts of the JWS including the header. - Assumes Header has already been set. - - - - Gets a representing the { key, 'value' } pair corresponding to the provided . - - If the key has no corresponding value, this method will throw. - - - - Gets the 'value' corresponding to the provided key from the JWT payload { key, 'value' }. - - If the key has no corresponding value, this method will throw. - - - - Tries to get the representing the { key, 'value' } pair corresponding to the provided . - - If the key has no corresponding value, returns false. Otherwise returns true. - - - - Tries to get the 'value' corresponding to the provided key from the JWT payload { key, 'value' }. - - If the key has no corresponding value, returns false. Otherwise returns true. - - - - Gets the 'value' corresponding to the provided key from the JWT header { key, 'value' }. - - If the key has no corresponding value, this method will throw. - - - - Tries to get the value corresponding to the provided key from the JWT header { key, 'value' }. - - If the key has no corresponding value, returns false. Otherwise returns true. - - - - A designed for creating and validating Json Web Tokens. - See: http://tools.ietf.org/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515. - - - - - Gets the Base64Url encoded string representation of the following JWT header: - { , }. - - The Base64Url encoded string representation of the unsigned JWT header. - - - - Gets the type of the . - - The type of - - - - Determines if the string is a well formed Json Web Token (JWT). - see: http://tools.ietf.org/html/rfc7519 - - String that should represent a valid JWT. - Uses matching: - JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$" - JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$" - JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$" - - - 'false' if the token is null or whitespace. - 'false' if token.Length is greater than . - 'true' if the token is in JSON compact serialization format. - - - - - Returns a value that indicates if this handler can validate a . - - 'true', indicating this instance can validate a . - - - - Creates an unsigned JWS (Json Web Signature). - - A string containing JSON which represents the JWT token payload. - if is null. - A JWS in Compact Serialization Format. - - - - Creates an unsigned JWS (Json Web Signature). - - A string containing JSON which represents the JWT token payload. - Defines the dictionary containing any custom header claims that need to be added to the JWT token header. - if is null. - if is null. - A JWS in Compact Serialization Format. - - - - Creates a JWS (Json Web Signature). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWS. - if is null. - if is null. - A JWS in Compact Serialization Format. - - - - Creates a JWS (Json Web Signature). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWS. - Defines the dictionary containing any custom header claims that need to be added to the JWT token header. - if is null. - if is null. - if is null. - if , - , , and/or - are present inside of . - A JWS in Compact Serialization Format. - - - - Creates a JWS(Json Web Signature). - - A that contains details of contents of the token. - A JWS in Compact Serialization Format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to encrypt the JWT. - A JWE in compact serialization format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWT. - Defines the security key and algorithm that will be used to encrypt the JWT. - if is null. - if is null. - if is null. - A JWE in compact serialization format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWT. - Defines the security key and algorithm that will be used to encrypt the JWT. - Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header. - if is null. - if is null. - if is null. - if is null. - if , - , , and/or - are present inside of . - A JWE in compact serialization format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to encrypt the JWT. - Defines the compression algorithm that will be used to compress the JWT token payload. - A JWE in compact serialization format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWT. - Defines the security key and algorithm that will be used to encrypt the JWT. - Defines the compression algorithm that will be used to compress the JWT token payload. - if is null. - if is null. - if is null. - if is null. - A JWE in compact serialization format. - - - - Creates a JWE (Json Web Encryption). - - A string containing JSON which represents the JWT token payload. - Defines the security key and algorithm that will be used to sign the JWT. - Defines the security key and algorithm that will be used to encrypt the JWT. - Defines the compression algorithm that will be used to compress the JWT token payload. - Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header. - if is null. - if is null. - if is null. - if is null. - if is null. - if , - , , and/or - are present inside of . - A JWE in compact serialization format. - - - - Compress a JWT token string. - - - - if is null. - if is null. - if the compression algorithm is not supported. - Compressed JWT token bytes. - - - - Creates a from a . - - The to use as a source. - Contains parameters for validating the token. - A containing the . - - - - Decrypts a JWE and returns the clear text - - the JWE that contains the cypher text. - contains crypto material. - the decoded / cleartext contents of the JWE. - if is null. - if is null. - if ' .Enc' is null or empty. - if decompression failed. - if ' .Kid' is not null AND decryption fails. - if the JWE was not able to be decrypted. - - - - Encrypts a JWS. - - A 'JSON Web Token' (JWT) in JWS Compact Serialization Format. - Defines the security key and algorithm that will be used to encrypt the . - if is null or empty. - if is null. - if both and . are null. - if the CryptoProviderFactory being used does not support the (algorithm), pair. - if unable to create a token encryption provider for the (algorithm), pair. - if encryption fails using the (algorithm), pair. - if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption). - - - - Encrypts a JWS. - - A 'JSON Web Token' (JWT) in JWS Compact Serialization Format. - Defines the security key and algorithm that will be used to encrypt the . - Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header. - if is null or empty. - if is null. - if is null. - if both and . are null. - if the CryptoProviderFactory being used does not support the (algorithm), pair. - if unable to create a token encryption provider for the (algorithm), pair. - if encryption fails using the (algorithm), pair. - if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption). - - - - Encrypts a JWS. - - A 'JSON Web Token' (JWT) in JWS Compact Serialization Format. - Defines the security key and algorithm that will be used to encrypt the . - Defines the compression algorithm that will be used to compress the 'innerJwt'. - if is null or empty. - if is null. - if is null or empty. - if both and . are null. - if the CryptoProviderFactory being used does not support the (algorithm), pair. - if unable to create a token encryption provider for the (algorithm), pair. - if compression using fails. - if encryption fails using the (algorithm), pair. - if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption). - - - - Encrypts a JWS. - - A 'JSON Web Token' (JWT) in JWS Compact Serialization Format. - Defines the security key and algorithm that will be used to encrypt the . - Defines the compression algorithm that will be used to compress the 'innerJwt'. - Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header. - if is null or empty. - if is null. - if is null or empty. - if is null or empty. - if both and . are null. - if the CryptoProviderFactory being used does not support the (algorithm), pair. - if unable to create a token encryption provider for the (algorithm), pair. - if compression using 'algorithm' fails. - if encryption fails using the (algorithm), pair. - if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption). - - - - Returns a to use when decrypting a JWE. - - The the token that is being decrypted. - The that is being decrypted. - A required for validation. - Returns a to use for signature validation. - If key fails to resolve, then null is returned - - - - Converts a string into an instance of . - - A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format. - A - 'token' is null or empty. - 'token.Length' is greater than . - If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized. - This method is unable to decrypt the payload. Use to obtain the payload. - - - - Converts a string into an instance of . - - A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format. - A - 'token' is null or empty. - 'token.Length' is greater than . - - - - Validates a JWS or a JWE. - - A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format. - A required for validation. - A - - - - Validates the JWT signature. - - - - - Obtains a and validates the signature. - - Bytes to validate. - Signature to compare against. - to use. - Crypto algorithm to use. - The being validated. - Priority will be given to over . - 'true' if signature is valid. - - - - Constants for Json Web Tokens. - - - - - Short header type. - - - - - Long header type. - - - - - Short token type. - - - - - Long token type. - - - - - JWS - Token format: 'header.payload.signature'. Signature is optional, but '.' is required. - - - - - JWE - Token format: 'protectedheader.encryptedkey.iv.cyphertext.authenticationtag'. - - - - - The number of parts in a JWE token. - - - - - The number of parts in a JWS token. - - - - - The maximum number of parts in a JWT. - - - - - JWE header alg indicating a shared symmetric key is directly used as CEK. - - - - - List of header parameter names see: http://tools.ietf.org/html/rfc7519#section-5. - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.10 - also:https://tools.ietf.org/html/rfc7519#section-5.2 - - - - - see:https://tools.ietf.org/html/rfc7516#section-4.1.2 - - - - - see:https://tools.ietf.org/html/rfc7518#section-4.7.1.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.2 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.3 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.4 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.9 - also:https://tools.ietf.org/html/rfc7519#section-5.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.6 - - - - - see:https://tools.ietf.org/html/rfc7515#page-12 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.5 - - - - - see:https://tools.ietf.org/html/rfc7516#section-4.1.3 - - - - - List of registered claims from different sources - http://tools.ietf.org/html/rfc7519#section-4 - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#HybridIDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - - - - - https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - - - - - http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://tools.ietf.org/html/rfc7519#section-5 - - - - - - - - - - - - - Represents the parameters needed to decrypt a JSON Web Token - - - - - Gets or sets signature algorithm that was used to create the signature. - - - - - Gets or sets the AuthenticationTag from the original raw data of this instance when it was created. - - - - - Gets or sets the Ciphertext from the original raw data of this instance when it was created. - - - - - Gets or sets the function used to attempt decompression with. - - - - - Gets or sets the encryption algorithm (Enc) of the token. - - - - - Gets the EncodedHeader from the original raw data of this instance when it was created. - - - - - Gets or sets the EncodedHeader from the original raw data of this instance when it was created. - - - - - Gets or sets the InitializationVector from the original raw data of this instance when it was created. - - - - - Gets or sets the collection of s to attempt to decrypt with. - - - - - Gets or sets the 'value' of the 'zip' claim. - - - - - A class which contains useful methods for processing JWT tokens. - - - - - Regex that is used to figure out if a token is in JWS format. - - - - - Regex that is used to figure out if a token is in JWE format. - - - - - Produces a signature over the 'input'. - - String to be signed - The that contain crypto specs used to sign the token. - The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ). - 'input' or 'signingCredentials' is null. - - - - Produces a signature over the 'input'. - - String to be signed - The that contain crypto specs used to sign the token. - should the be cached. - The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ). - 'input' or 'signingCredentials' is null. - - - - Decompress JWT token bytes. - - - - if is null. - if is null. - if the decompression is not supported. - if decompression using fails. - Decompressed JWT token - - - - Decrypts a Json Web Token. - - The Json Web Token - The validation parameters containing cryptographic material. - The decryption parameters container. - The decrypted, and if the 'zip' claim is set, decompressed string representation of the token. - - - - Generates key bytes. - - - - - Gets all decryption keys. - - - - - Gets the DateTime using the number of seconds from 1970-01-01T0:0:0Z (UTC) - - Claim in the payload that should map to an integer, float, or string. - The payload that contains the desired claim value. - If the claim is not found, the function returns: DateTime.MinValue - - If the value of the claim cannot be parsed into a long. - The DateTime representation of a claim. - - - - Returns a to use when validating the signature of a token. - - The kid field of the token being validated - The x5t field of the token being validated - A required for validation. - Returns a to use for signature validation. - If key fails to resolve, then null is returned - - - - Log messages and codes - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml.meta deleted file mode 100644 index e3906062..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.JsonWebTokens.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 339aadddbc5274a48922bede53d9a543 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.dll.meta deleted file mode 100644 index 81aeb856..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 6e9f3bf71b2f85845a2704fc2782d786 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 1 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml deleted file mode 100644 index f12156e7..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml +++ /dev/null @@ -1,428 +0,0 @@ - - - - Microsoft.IdentityModel.Logging - - - - - Event source based logger to log different events. - - - - - Static logger that is exposed externally. An external application or framework can hook up a listener to this event source to log data in a custom way. - - - - - Flag which indicates whether or not PII is shown in logs. False by default. - - - - - String that is used in place of any arguments to log messages if the 'ShowPII' flag is set to false. - - - - - Indicates whether or the log message header (contains library version, date/time, and PII debugging information) has been written. - - - - - The log message that indicates the current library version. - - - - - The log message that indicates the date. - - - - - The log message that is shown when PII is off. - - - - - The log message that is shown when PII is off. - - - - - Writes an event log by using the provided string argument and current UTC time. - No level filtering is done on the event. - - The log message. - No level filtering. - - - - Writes an event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes a verbose event log by using the provided string argument and current UTC time. - - The log message. - - - - Writes a verbose event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes an information event log by using the provided string argument and current UTC time. - - The log message. - - - - Writes an information event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes a warning event log by using the provided string argument and current UTC time. - - The log message. - - - - Writes a warning event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes an error event log by using the provided string argument and current UTC time. - - The log message. - - - - Writes an error event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes a critical event log by using the provided string argument and current UTC time. - - The log message. - - - - Writes a critical event log by using the provided string argument, current UTC time and the provided arguments list. - - The log message. - An object array that contains zero or more objects to format. - - - - Writes an exception log by using the provided event identifer, exception argument, string argument and current UTC time. - - - - The log message. - - - - Writes an exception log by using the provided event identifer, exception argument, string argument, arguments list and current UTC time. - - - - The log message. - An object array that contains zero or more objects to format. - - - - Minimum log level to log events. Default is Warning. - - - - - Provides a way to add and remove telemetry data. - - - - - Get the string that represents the client SKU. - - - - - Get the string that represents the client version. - - - - - Adds a key and its value to the collection of telemetry data. - - The name of the telemetry. - The value of the telemetry. - true if the key is successfully added; otherwise, false. - - - - Removes a key and its value from the collection of telemetry data. - - The name of the telemetry. - true if the key is successfully removed; otherwise, false. - - - - Helper class for logging. - - - - - Logs an exception using the event source logger and returns new exception. - - argument that is null or empty. - EventLevel is set to Error. - - - - Logs an exception using the event source logger and returns new typed exception. - - message to log. - EventLevel is set to Error. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the argument whose value generated the ArgumentException. - message to log. - EventLevel is set to Error. - - - - Logs an exception using the event source logger and returns new typed exception. - - Format string of the log message. - An object array that contains zero or more objects to format. - EventLevel is set to Error. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the argument whose value generated the ArgumentException. - Format string of the log message. - An object array that contains zero or more objects to format. - EventLevel is set to Error. - - - - Logs an exception using the event source logger and returns new typed exception. - - the inner to be added to the outer exception. - message to log. - EventLevel is set to Error. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the argument whose value generated the ArgumentException. - the inner to be added to the outer exception. - message to log. - EventLevel is set to Error. - - - - Logs an exception using the event source logger and returns new typed exception. - - the inner to be added to the outer exception. - Format string of the log message. - An object array that contains zero or more objects to format. - EventLevel is set to Error. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the argument whose value generated the ArgumentException. - the inner to be added to the outer exception. - Format string of the log message. - An object array that contains zero or more objects to format. - EventLevel is set to Error. - - - - Logs an exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - message to log. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Identifies the argument whose value generated the ArgumentException. - message to log. - - - - Logs an exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Identifies the argument whose value generated the ArgumentException. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Logs an exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - the inner to be added to the outer exception. - message to log. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Identifies the argument whose value generated the ArgumentException. - the inner to be added to the outer exception. - message to log. - - - - Logs an exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - the inner to be added to the outer exception. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Logs an argument exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Identifies the argument whose value generated the ArgumentException. - the inner to be added to the outer exception. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Logs an exception using the event source logger. - - The exception to log. - - - - Logs an exception using the event source logger. - - Identifies the level of an event to be logged. - The exception to log. - - - - Logs an information event. - - The log message. - An object array that contains zero or more objects to format. - - - - Logs a verbose event. - - The log message. - An object array that contains zero or more objects to format. - - - - Logs a warning event. - - The log message. - An object array that contains zero or more objects to format. - - - - Logs an exception using the event source logger and returns new typed exception. - - Identifies the level of an event to be logged. - Identifies the argument whose value generated the ArgumentException. - the inner to be added to the outer exception. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Formats the string using InvariantCulture - - Format string. - Format arguments. - Formatted string. - - - - Log messages and codes for Microsoft.IdentityModel.Logging - - - - - Event listener that writes logs to a file or a fileStream provided by user. - - - - - Name of the default log file, excluding its path. - - - - - Initializes a new instance of that writes logs to text file. - - - - - Initializes a new instance of that writes logs to text file. - - location of the file where log messages will be written. - - - - Initializes a new instance of that writes logs to text file. - - StreamWriter where logs will be written. - - - - Called whenever an event has been written by an event source for which the event listener has enabled events. - - - - - - Releases all resources used by the current instance of the class. - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml.meta deleted file mode 100644 index e3f00d71..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Logging.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: aa525b46a506c8745a8b7a25ad93a592 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.dll.meta deleted file mode 100644 index 0497b9cb..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 46188f8f569098f46bfed8eb6f10c532 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 1 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml deleted file mode 100644 index 5774f716..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml +++ /dev/null @@ -1,15629 +0,0 @@ - - - - Microsoft.IdentityModel.Tokens - - - - - This adapter abstracts the 'RSA' differences between versions of .Net targets. - - - - - Calls and - - - - - Base class for a Security Key that contains Asymmetric key material. - - - - - Default constructor - - - - - This must be overridden to get a bool indicating if a private key exists. - - true if it has a private key; otherwise, false. - - - - Gets the status of the private key. - - 'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine. - - - - Enum for the existence of private key - - - - - private key exists for sure - - - - - private key doesn't exist for sure - - - - - unable to determine the existence of private key - - - - - Provides signature and verification operations for Asymmetric Algorithms using a . - - - - - Mapping from algorithm to minimum .KeySize when creating signatures. - - - - - Mapping from algorithm to minimum .KeySize when verifying signatures. - - - - - Initializes a new instance of the class used to create and verify signatures. - - The that will be used for signature operations. - The signature algorithm to apply. - - - - Initializes a new instance of the class used to create and verify signatures. - - The that will be used for signature operations. - The signature algorithm to apply. - If this is required to create signatures then set this to true. - - Creating signatures requires that the has access to a private key. - Verifying signatures (the default), does not require access to the private key. - - is null. - is null or empty. - is true and there is no private key. - If and algorithm pair are not supported. - - willCreateSignatures is true and .KeySize is less than the size corresponding to the given algorithm in . - - - .KeySize is less than the size corresponding to the algorithm in . Note: this is always checked. - - If the runtime is unable to create a suitable cryptographic provider. - - - - Gets the mapping from algorithm to the minimum .KeySize for creating signatures. - - - - - Gets the mapping from algorithm to the minimum .KeySize for verifying signatures. - - - - - Creating a Signature requires the use of a . - This method returns the - that describes the to use when generating a Signature. - - The SignatureAlgorithm in use. - The to use. - if is null or whitespace. - if is not supported. - - - - For testing purposes - - - - - Produces a signature over the 'input' using the and algorithm passed to . - - The bytes to be signed. - A signature over the input. - if is null. - if .Length == 0. - If has been called. - Sign is thread safe. - - - - Validates that an asymmetric key size is of sufficient size for a SignatureAlgorithm. - - The asymmetric key to validate. - Algorithm for which this key will be used. - Whether they key will be used for creating signatures. - if is null. - if is null or empty. - if .KeySize is less than the minimum - acceptable size. - - for minimum signing sizes. - for minimum verifying sizes. - - - - - Verifies that the over using the - and specified by this - are consistent. - - The bytes to generate the signature over. - The value to verify against. - true if signature matches, false otherwise. - is null or has length == 0. - is null or has length == 0. - If has been called. - Verify is thread safe. - - - - Calls to release managed resources. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - Encodes and Decodes strings as Base64Url encoding. - - - - - The following functions perform base64url encoding which differs from regular base64 encoding as follows - * padding is skipped so the pad character '=' doesn't have to be percent encoded - * the 62nd and 63rd regular base64 encoding characters ('+' and '/') are replace with ('-' and '_') - The changes make the encoding alphabet file and URL safe. - - string to encode. - Base64Url encoding of the UTF8 bytes. - - - - Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify - the subset as an offset in the input array, and the number of elements in the array to convert. - - An array of 8-bit unsigned integers. - An offset in inArray. - The number of elements of inArray to convert. - The string representation in base 64 url encoding of length elements of inArray, starting at position offset. - 'inArray' is null. - offset or length is negative OR offset plus length is greater than the length of inArray. - - - - Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify - the subset as an offset in the input array, and the number of elements in the array to convert. - - An array of 8-bit unsigned integers. - The string representation in base 64 url encoding of length elements of inArray, starting at position offset. - 'inArray' is null. - offset or length is negative OR offset plus length is greater than the length of inArray. - - - - Converts the specified string, which encodes binary data as base-64-url digits, to an equivalent 8-bit unsigned integer array. - base64Url encoded string. - UTF8 bytes. - - - - Decodes the string from Base64UrlEncoded to UTF8. - - string to decode. - UTF8 string. - - - - An opaque context used to store work when working with authentication artifacts. - - - - - Instantiates a new with a default activityId. - - - - - Instantiates a new with an activityId. - - - - - Gets or set a that will be used in the call to EventSource.SetCurrentThreadActivityId before logging. - - - - - Gets or sets a boolean controlling if logs are written into the context. - Useful when debugging. - - - - - The collection of logs associated with a request. Use to control capture. - - - - - Gets or sets an that enables custom extensibility scenarios. - - - - - Constants for compression algorithms. - - - - - Compression provider factory for compression and decompression. - - - - - Static constructor that initializes the default . - - - - - Default constructor for . - - - - - Constructor that creates a deep copy of given object. - - to copy from. - - - - Returns the default instance. - - - - - Extensibility point for custom compression support application wide. - - - - - Answers if an algorithm is supported. - - the name of the crypto algorithm. - true if the algorithm is supported, false otherwise. - - - - Returns a for a specific algorithm. - - the decompression algorithm. - a . - - - - Definition of cache for crypto providers - - - - - Returns the cache key to use when looking up an entry into the cache for a - - the to create the key for. - the cache key to use for finding a . - - - - Returns the 'key' that will be used to find a crypto provider in this cache. - - the key that is used to by the crypto provider. - the algorithm that is used by the crypto provider. - the typeof the crypto provider obtained by calling object.GetType(). - the cache key to use for finding a crypto provider. - - - - Trys to adds a to this cache. - - to cache. - true if the was added, false if the cache already contained the - - - - Trys to find a in this cache. - - the key that is used to by the crypto provider. - the algorithm that is used by the crypto provider. - the typeof the crypto provider obtained by calling object.GetType(). - a bool to indicate if the will be used to sign. - the if found. - true if a was found, false otherwise. - - - - Trys to remove a from this cache. - - to remove. - true if the was removed, false if the was not found. - - - - Specifies the CryptoProviderCacheOptions which can be used to configure the internal cryptoprovider cache. - We are using our own simple LRU caching implementation across all targets. - See for more details. - - - - - Default value for . - - - - - Gets or sets the size of the cache (in number of items). - 20% of the cache will be evicted whenever the cache gets to 95% of this size. - Items will be evicted from least recently used to most recently used. - - - - - Creates cryptographic operators by specifying a 's and algorithms. - - - - - Returns the default instance. - - - - - Gets or sets the default value for caching of 's. - - - - - Gets or sets the maximum size of the object pool used by the SignatureProvider that are used for crypto objects. - - - - - Static constructor that initializes the default . - - - - - Default constructor for . - - - - - Initializes an instance of a . - - - The cache to use for caching CryptoProviders - - - - - Constructor that creates a deep copy of given object. - - to copy from. - - - - Gets the - - - - - Extensibility point for creating custom cryptographic operators. - - By default, if set, will be called before creating cryptographic operators. - If true is returned, then will be called. The will throw if the - Cryptographic operator returned is not of the correct type. - - - - Gets or sets a bool controlling if should be cached. - - - - - Gets or sets the maximum size of the object pool used by the SignatureProvider that are used for crypto objects. - - - - - Creates an instance of for a specific <SecurityKey, Algorithm>. - - the to use. - the algorithm to use. - thrown if is null. - thrown if is null or empty. - thrown if and algorithm pair are not supported. - thrown if returns a type that is not assignable from . - - If is set and returns true. - is called to obtain the . - - When finished with the call . - - an instance of - - - - Creates an instance of for a specific <SecurityKey, Algorithm>. - - the to use. - the algorithm to use. - thrown if is null. - thrown if is null or empty. - thrown if and algorithm pair are not supported. - thrown if returns a type not assignable from . - - If is set and returns true. - is called to obtain the . - - When finished with the call . - - an instance of - - - - Creates an instance of for a specific <SecurityKey, Algorithm>. - - the to use. - the algorithm to use. - thrown if is null. - thrown if is null or empty. - thrown if and algorithm pair are not supported. - thrown if returns a type that is not assignable from . - - If is set and returns true. - is called to obtain the . - - When finished with the call . - - an instance of - - - - Creates a that creates a signature with the algorithm and . - - the to use for signing. - the algorithm to use for signing. - thrown if is null. - thrown if is null or empty. - thrown if is too small. - thrown if is not assignable from or . - thrown if the key / algorithm is not supported. - thrown if returns a type that is not assignable from . - - AsymmetricSignatureProviders require access to a PrivateKey for Signing. - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A that can be used to create a signature using the and algorithm. - - - - Creates a that creates a signature with the algorithm and . - - the to use for signing. - the algorithm to use for signing. - indicates if the should be cached for reuse. - thrown if is null. - thrown if is null or empty. - thrown if is too small. - thrown if is not assignable from or . - thrown if the key / algorithm is not supported. - thrown if returns a type that is not assignable from . - - AsymmetricSignatureProviders require access to a PrivateKey for Signing. - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A that can be used to create a signature using the and algorithm. - - - - Creates a that supports the and algorithm. - - The to use for signature verification. - The algorithm to use for verifying. - thrown if is null. - thrown if is null or empty. - thrown if is too small. - thrown if is not assignable from or . - thrown if the key / algorithm is not supported. - thrown if returns a type that is not assignable from . - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A that can be used to validate a signature using the and algorithm. - - - - Creates a that supports the and algorithm. - - The to use for signature verification. - The algorithm to use for verifying. - should the be cached. - thrown if is null. - thrown if is null or empty. - thrown if is too small. - thrown if is not assignable from or . - thrown if the key / algorithm is not supported. - thrown if returns a type that is not assignable from . - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A that can be used to validate a signature using the and algorithm. - - - - Creates a for a specific algorithm. - - the name of the hash algorithm to create. - thrown if is null or empty. - thrown if returns a type that is not assignable from . - thrown if is not supported. - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A . - - - - Creates a for a specific algorithm. - - the name of the hash algorithm to create. - thrown if is null or empty. - thrown if returns a type that is not assignable from . - thrown if is not supported. - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A . - - - - Returns a for a specific algorithm. - - bytes to use to create the Keyed Hash. - the name of the keyed hash algorithm to create. - thrown if is null. - thrown if is null or empty. - thrown if returns a type that is not assignable from . - is not supported. - When finished with the call . - If is set and returns true. - is called to obtain the . - - - A . - - - - For some security key types, in some runtimes, it's not possible to extract public key material and create an . - In these cases, will be an empty string, and these keys should not be cached. - - to be examined. - True if should be cached, false otherwise. - - - - Checks if an algorithm is supported. - - the name of the Hash algorithm. - Only considers known Hash algorithms. - true if: - - If is set and returns true. - - The algorithm is supported. - - - - - - Checks if the algorithm and is supported. - - the security algorithm to apply. - the . - Algorithms are supported for specific key types. - For example: - and will return true. - and will return false. - - true if: - - If is set and returns true. - - The algorithm / key pair is supported. - - - - - - When finished with a call this method for cleanup. The default behavior is to call - - to be released. - thrown if is null. - - - - When finished with a call this method for cleanup."/> - - to be released. - thrown if is null. - - - - When finished with a call this method for cleanup."/> - - to be released. - thrown if is null. - - - - When finished with a call this method for cleanup. The default behavior is to call - - to be released. - thrown if is null. - - - - Helper class for adding DateTimes and Timespans. - - - - - Add a DateTime and a TimeSpan. - The maximum time is DateTime.MaxTime. It is not an error if time + timespan > MaxTime. - Just return MaxTime. - - Initial value. - to add. - as the sum of time and timespan. - - - - Gets the Maximum value for a DateTime specifying kind. - - DateTimeKind to use. - DateTime of specified kind. - - - - Gets the Minimum value for a DateTime specifying kind. - - DateTimeKind to use. - DateTime of specified kind. - - - - Ensures that DataTime is UTC. - - to convert. - - - - - Ensures that DateTime is UTC. - - to convert. - - - - - A compression provider that supports compression and decompression using the algorithm. - - - - - Initializes a new instance of the class used to compress and decompress used the algorithm. - - - - - Initializes a new instance of the class used to compress and decompress used the algorithm. - The compression level to use when compressing. - - - - - Gets the compression algorithm. - - - - - Specifies whether compression should emphasize speed or compression size. - Set to by default. - - - - - Decompress the value using DEFLATE algorithm. - - the bytes to decompress. - the decompressed bytes. - - - - Compress the value using the DEFLATE algorithm. - - the bytes to compress. - the compressed bytes. - - - - Answers if a compression algorithm is supported. - - the name of the compression algorithm. - true if the compression algorithm is supported, false otherwise. - - - - This adapter abstracts the differences between versions of .Net targets. - - - - - Initializes a new instance of the class. - - - creation is not supported by some platforms. - For more details, see https://aka.ms/IdentityModel/create-ecdsa. - - - - - Creates an ECDsa object using the and . - - - - - Creates an ECDsa object using the and . - 'ECParameters' structure is available in .NET Framework 4.7+, .NET Standard 1.6+, and .NET Core 1.0+. - This method is supported only on Windows as other platforms don't support operations with . - - - - - Returns the size of key in bytes - - Represents ecdsa curve -P256, P384, P521 - Size of the key in bytes - - - - Magic numbers identifying ECDSA blob types - - - - - Returns the magic value representing the curve corresponding to the curve id. - - Represents ecdsa curve -P256, P384, P512 - Whether the provider will create signatures or not - Uint representing the magic number - - - - Tests if user's runtime platform supports operations using . - - True if operations using are supported on user's runtime platform, false otherwise. - - - - Represents a ECDsa security key. - - - - - Returns a new instance of . - - - - - - instance used to initialize the key. - - - - - Gets a bool indicating if a private key exists. - - true if it has a private key; otherwise, false. - - - - Gets an enum indicating if a private key exists. - - 'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine. - - - - Gets key size. - - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - A class for properties that are used for token encryption. - - - - - Initializes a new instance of the class. - - . - A key wrap algorithm to use when encrypting a session key. - Data encryption algorithm to apply. - if 'certificate' is null. - if 'alg' is null or empty. - if 'enc' is null or empty. - - - - Initializes a new instance of the class. - - to use when encrypting a session key. - A key wrap algorithm to use when encrypting a session key. - Data encryption algorithm to apply. - if 'key' is null. - if 'alg' is null or empty. - if 'enc' is null or empty. - - - - Initializes a new instance of the class. - - Used in scenarios when a key represents a 'shared' symmetric key. - For example, SAML 2.0 Assertion will be encrypted using a provided symmetric key - which won't be serialized to a SAML token. - - to apply. - Data encryption algorithm to apply. - If the is not a . - if 'enc' is null or empty. - - - - Gets the key wrap algorithm used for session key encryption. - - - - - Gets the data encryption algorithm. - - - - - Users can override the default with this property. This factory will be used for creating encryption providers. - - - - - Gets the used for encryption. - - - - - Provides authenticated encryption and decryption services. - - - - - Initializes a new instance of the class used for encryption and decryption. - - The that will be used for crypto operations. - The encryption algorithm to apply. - 'key' is null. - 'algorithm' is null or whitespace. - key size is not large enough. - 'algorithm' is not supported. - a symmetricSignatureProvider is not created. - - - - Gets the encryption algorithm that is being used. - - - - - Gets or sets a user context for a . - - This is null by default. This can be used by applications for extensibility scenarios. - - - - Gets the that is being used. - - - - - Encrypts the 'plaintext' - - the data to be encrypted. - will be combined with iv and ciphertext to create an authenticationtag. - containing ciphertext, iv, authenticationtag. - plaintext is null or empty. - authenticationData is null or empty. - AES crypto operation threw. See inner exception for details. - - - - Encrypts the 'plaintext' - - the data to be encrypted. - will be combined with iv and ciphertext to create an authenticationtag. - initialization vector for encryption. - containing ciphertext, iv, authenticationtag. - is null or empty. - is null or empty. - Thrown if the AES crypto operation threw. See inner exception for details. - Thrown if the internal is disposed. - - - - Decrypts ciphertext into plaintext - - the encrypted text to decrypt. - the authenticateData that is used in verification. - the initialization vector used when creating the ciphertext. - the authenticationTag that was created during the encyption. - decrypted ciphertext - is null or empty. - is null or empty. - is null or empty. - is null or empty. - Thrown if the signature over the authenticationTag fails to verify. - Thrown if the AES crypto operation threw. See inner exception. - Thrown if the internal is disposed. - - - - Calls and - - - - - Releases managed resources. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - Checks if an 'key, algorithm' pair is supported - - the - the algorithm to check. - true if 'key, algorithm' pair is supported. - - - - The algorithm parameter logically defines a HMAC algorithm. - This method returns the HMAC to use. - - - - - - - Called to obtain the byte[] needed to create a - - that will be used to obtain the byte[]. - [] that is used to populated the KeyedHashAlgorithm. - if is null. - if a byte[] can not be obtained from SecurityKey. - and are supported. - For a .Key is returned - For a Base64UrlEncoder.DecodeBytes is called with if == JsonWebAlgorithmsKeyTypes.Octet - - - - - Checks that the key has sufficient length - - that contains bytes. - the algorithm to apply. - if is null. - if is null or empty. - if is not a supported algorithm. - - - - Contains the results of operation. - - - - - Initializes a new - - the used during - protected text. - the initialization vector used. - the bytes that need be passed to . - - - - Gets the . - - - - - Gets the Ciphertext. - - - - - Gets the initialization vector. - - - - - Gets the authentication tag - - - - - Provides Wrap key and Unwrap key services. - - - - - Gets the KeyWrap algorithm that is being used. - - - - - Gets or sets a user context for a . - - This is null by default. This can be used by runtimes or for extensibility scenarios. - - - - Gets the that is being used. - - - - - Calls and - - - - - Can be over written in descendants to dispose of internal components. - - true, if called from Dispose(), false, if invoked inside a finalizer - - - - Unwrap a key. - - key to unwrap. - Unwrapped key. - - - - Wrap a key. - - the key to be wrapped - wrapped key. - - - - Provides RSA Wrap key and Unwrap key services. - - - - - Initializes a new instance of used for wrapping and un-wrappping keys. - These keys are usually symmetric session keys that are wrapped using the recipients public key. - The that will be used for cryptographic operations. - The KeyWrap algorithm to apply. - Whether this is required to un-wrap keys. If true, the private key is required. - 'key' is null. - 'algorithm' is null. - The key size doesn't match the algorithm. - If and algorithm pair are not supported. - Failed to create RSA algorithm with provided key and algorithm. - - - - - Gets the KeyWrap algorithm that is being used. - - - - - Gets or sets a user context for a . - - This is null by default. This is for use by the application and not used by this SDK. - - - - Gets the that is being used. - - - - - Disposes of internal components. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - Checks if an algorithm is supported. - - The that will be used for crypto operations. - The KeyWrap algorithm to apply. - true if the algorithm is supported; otherwise, false. - - - - Unwrap a key using RSA decryption. - - the bytes to unwrap. - Unwrapped key - 'keyBytes' is null or length == 0. - If has been called. - Failed to unwrap the wrappedKey. - If the internal RSA algorithm is null. - - - - Wrap a key using RSA encryption. - - the key to be wrapped - A wrapped key - 'keyBytes' is null or has length == 0. - If has been called. - Failed to wrap the 'keyBytes'. - If the internal RSA algorithm is null. - - - - Provides Wrap key and Unwrap key services. - - - - - Initializes a new instance of the class used for wrap key and unwrap key. - The that will be used for crypto operations. - The KeyWrap algorithm to apply. - 'key' is null. - 'algorithm' is null. - If and algorithm pair are not supported. - The cannot be converted to byte array - The keysize doesn't match the algorithm. - Failed to create symmetric algorithm with provided key and algorithm. - - - - - Gets the KeyWrap algorithm that is being used. - - - - - Gets or sets a user context for a . - - This is null by default. This can be used by runtimes or for extensibility scenarios. - - - - Gets the that is being used. - - - - - Disposes of internal components. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - Returns the . - - - The cannot be converted to byte array - The keysize doesn't match the algorithm. - Failed to create symmetric algorithm with provided key and algorithm. - - - - Answers if an algorithm is supported - - the - the algorithm to use - true if the algorithm is supported; otherwise, false. - - - - Unwrap a key using Symmetric decryption. - - bytes to unwrap - Unwraped key - 'keyBytes' is null or length == 0. - 'keyBytes' is not a multiple of 8. - If has been called. - Failed to unwrap the wrappedKey. - - - - Wrap a key using Symmetric encryption. - - the key to be wrapped - The wrapped key result - 'keyBytes' is null or has length 0. - 'keyBytes' is not a multiple of 8. - If has been called. - Failed to wrap 'keyBytes'. - - - - Returns the absolute DateTime or the Seconds since Unix Epoch, where Epoch is UTC 1970-01-01T0:0:0Z. - - - - - DateTime as UTV for UnixEpoch - - - - - Per JWT spec: - Gets the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the desired date/time. - - The DateTime to convert to seconds. - if dateTimeUtc less than UnixEpoch, return 0 - the number of seconds since Unix Epoch. - - - - Creates a DateTime from epoch time. - - Number of seconds. - The DateTime in UTC. - - - - This is an LRU cache implementation that relies on an event queue rather than locking to achieve thread safety. - This approach has been decided on in order to optimize the performance of the get and set operations on the cache. - This cache contains a doubly linked list in order to maintain LRU order, as well as a dictionary (map) to keep track of - keys and expiration times. The linked list (a structure which is not thread-safe) is NEVER modified directly inside - an API call (e.g. get, set, remove); it is only ever modified sequentially by a background thread. On the other hand, - the map is a which may be modified directly inside an API call or - through eventual processing of the event queue. This implementation relies on the principle of 'eventual consistency': - though the map and it's corresponding linked list may be out of sync at any given point in time, they will eventually line up. - See here for more details: - https://aka.ms/identitymodel/caching - - The key type to be used by the cache. - The value type to be used by the cache - - - - FOR TESTING PURPOSES ONLY. - - - - Each time a node gets accessed, it gets moved to the beginning (head) of the list. - - - Removes a particular key from the cache. - - - - FOR TESTING ONLY. - - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - - FOR TESTING ONLY. - - - - - Calls and - - - - - If is true, this method disposes of . - - True if called from the method, false otherwise. - - - - Thrown when JWE compression fails. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Thrown when JWE decompression fails. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Represents a security token exception when decryption failed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Represents a security token exception when encryption failed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - This exception is thrown when a security token contained a key identifier but the key was not found by the runtime - when decrypting a token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Represents a security token exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Throw this exception when a received Security Token has expiration time in the past. - - - - - Gets or sets the Expires value that created the validation exception. This value is always in UTC. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when a cryptographic algorithm is invalid. - - - - - Gets or sets the invalid algorithm that created the validation exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Additional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Additional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when 'audience' of a token was not valid. - - - - - Gets or sets the InvalidAudience that created the validation exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when 'issuer' of a token was not valid. - - - - - Gets or sets the InvalidIssuer that created the validation exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when 'lifetime' of a token was not valid. - - - - - Gets or sets the NotBefore value that created the validation exception. This value is always in UTC. - - - - - Gets or sets the Expires value that created the validation exception. This value is always in UTC. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when 'signature' of a token was not valid. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Throw this exception when a received Security Token has an invalid issuer signing key. - - - - - Gets or sets the SigningKey that was found invalid. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - This exception is thrown when the token type ('typ' header claim) of a JWT token is invalid. - - - - - Gets or sets the invalid type that created the validation exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Additional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Additional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - Represents a key wrap exception when encryption failed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - This exception is thrown when a security is missing an ExpirationTime. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Throw this exception when a received Security token has an effective time - in the future. - - - - - Gets or sets the NotBefore value that created the validation exception. This value is always in UTC. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - This exception is thrown when an add to the TokenReplayCache fails. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - Throw this exception when a received Security Token has been replayed. - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of - - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - This exception is thrown when a security token contained a key identifier but the key was not found by the runtime. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - This exception is thrown when a security token contained a key identifier but the key was not found by the runtime - and when validation errors exist over the security token. This exception is not intended to be used as a signal - to refresh keys. - - - - - Indicates the type of the validation failure. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The validation failures. - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - - - - Initializes a new instance of the class. - - Addtional information to be included in the exception and displayed to user. - A that represents the root cause of the exception. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - - - - Represents a security token validation exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Initializes a new instance of the class. - - the that holds the serialized object data. - The contextual information about the source or destination. - - - - The reason for being unable to validate - - - - - Indicates no validation failures - - - - - Indicates that the lifetime was invalid - - - - - Indicates that the issuer was invalid - - - - - Compression provider interface. - - - - - Gets the compression algorithm. - - - - - Called to determine if an algorithm is supported. - - the algorithm that defines the compression method. - true if supported - - - - Decompress. - - the value to decompress. - - - - Compress. - - the value to decompress. - - - - Provides extensibility for cryptographic operators. - If custom operators are needed for then can be set to - return these operators. will be before each creation. - - - - - Called to determine if a cryptographic operation is supported. - - the algorithm that defines the cryptographic operator. - the arguments required by the cryptographic operator. May be null. - true if supported - - - - returns a cryptographic operator that supports the algorithm. - - the algorithm that defines the cryptographic operator. - the arguments required by the cryptographic operator. May be null. - call when finished with the object. - - - - called to release the object returned from - - the object returned from . - - - - Defines a cache for crypto providers. - Current support is limited to only. - - - - - Creates a new instance of using the default . - - - - - Creates a new instance of using the specified . - - The options used to configure the . - - - - Creates a new instance of using the specified . - - The options used to configure the . - Options used to create the event queue thread. - The time used in ms for the timeout interval of the event queue. Defaults to 500 ms. - - - - Returns the cache key to use when looking up an entry into the cache for a - - the to create the key for. - if signatureProvider is null. - the cache key to use for finding a . - - - - Returns the 'key' that will be used to find a crypto provider in this cache. - - the key that is used to by the crypto provider. - the algorithm that is used by the crypto provider. - the typeof the crypto provider obtained by calling object.GetType(). - if securityKey is null. - if algorithm is null or empty string. - if typeofProvider is null or empty string. - the cache key to use for finding a crypto provider. - - - - Trys to adds a to this cache. - - to cache. - if signatureProvider is null. - - true if the was added, false if the cache already contained the or if should not be cached. - - if the is added will be set to 'this'. - - - - Trys to find a to this cache. - - the key that is used to by the crypto provider. - the algorithm that is used by the crypto provider. - the typeof the crypto provider obtained by calling object.GetType(). - a bool to indicate if the will be used to sign. - the if found. - if securityKey is null. - if algorithm is null or empty string. - if typeofProvider is null or empty string. - true if a was found, false otherwise. - - - - Trys to remove a from this cache. - - to remove. - if signatureProvider is null. - true if the was removed, false if the was not found. - if the is removed will be set to null. - - - - Calls and - - - - - If is true, this method disposes of and . - - True if called from the method, false otherwise. - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - FOR TESTING ONLY. - - - - - Validators meant to be kept internal - - - - - Called after signature validation has failed. Will always throw an exception. - - - If the lifetime and issuer are valid - - - If the lifetime or issuer are invalid - - - - - Called after signature validation has failed. Will always throw an exception. - - - If the lifetime and issuer are valid - - - If the lifetime or issuer are invalid - - - - - ISecurityTokenValidator - - - - - Returns true if the token can be read, false otherwise. - - - - - Returns true if a token can be validated. - - - - - Gets and sets the maximum size in bytes, that a will be processed. - - - - - Validates a token passed as a string using - - - - - Interface that defines a simple cache for tacking replaying of security tokens. - - - - - Try to add a securityToken. - - the security token to add. - the time when security token expires. - true if the security token was successfully added. - - - - Try to find securityToken - - the security token to find. - true if the security token is found. - - - - Constants for JsonWebAlgorithms "kty" Key Type (sec 6.1) - http://tools.ietf.org/html/rfc7518#section-6.1 - - - - - Represents a JSON Web Key as defined in http://tools.ietf.org/html/rfc7517. - - - - - Returns a new instance of . - - A string that contains JSON Web Key parameters in JSON format. - - If 'json' is null or empty. - If 'json' fails to deserialize. - - - - Initializes an new instance of . - - - - - Initializes an new instance of from a json string. - - A string that contains JSON Web Key parameters in JSON format. - If 'json' is null or empty. - If 'json' fails to deserialize. - - - - If this was converted to or from a SecurityKey, this field will be set. - - - - - When deserializing from JSON any properties that are not defined will be placed here. - - - - - Gets or sets the 'alg' (KeyType).. - - - - - Gets or sets the 'crv' (ECC - Curve).. - - - - - Gets or sets the 'd' (ECC - Private Key OR RSA - Private Exponent).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'dp' (RSA - First Factor CRT Exponent).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'dq' (RSA - Second Factor CRT Exponent).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'e' (RSA - Exponent).. - - - - - Gets or sets the 'k' (Symmetric - Key Value).. - - Base64urlEncoding - - - - Gets the key id of this . - - - - - Gets the 'key_ops' (Key Operations).. - - - - - Gets or sets the 'kid' (Key ID).. - - - - - Gets or sets the 'kty' (Key Type).. - - - - - Gets or sets the 'n' (RSA - Modulus).. - - Value is formated as: Base64urlEncoding - - - - Gets or sets the 'oth' (RSA - Other Primes Info).. - - - - - Gets or sets the 'p' (RSA - First Prime Factor).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'q' (RSA - Second Prime Factor).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'qi' (RSA - First CRT Coefficient).. - - Value is formated as: Base64urlUInt - - - - Gets or sets the 'use' (Public Key Use).. - - - - - Gets or sets the 'x' (ECC - X Coordinate).. - - Value is formated as: Base64urlEncoding - - - - Gets the 'x5c' collection (X.509 Certificate Chain).. - - - - - Gets or sets the 'x5t' (X.509 Certificate SHA-1 thumbprint).. - - - - - Gets or sets the 'x5t#S256' (X.509 Certificate SHA-1 thumbprint).. - - - - - Gets or sets the 'x5u' (X.509 URL).. - - - - - Gets or sets the 'y' (ECC - Y Coordinate).. - - Value is formated as: Base64urlEncoding - - - - Gets the key size of . - - - - - Gets a bool indicating if a private key exists. - - true if it has a private key; otherwise, false. - - - - Gets a bool that determines if the 'key_ops' (Key Operations) property should be serialized. - This is used by Json.NET in order to conditionally serialize properties. - - true if 'key_ops' (Key Operations) is not empty; otherwise, false. - - - - Gets a bool that determines if the 'x5c' collection (X.509 Certificate Chain) property should be serialized. - This is used by Json.NET in order to conditionally serialize properties. - - true if 'x5c' collection (X.509 Certificate Chain) is not empty; otherwise, false. - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - Creates a JsonWebKey representation of an asymmetric public key. - - JsonWebKey representation of an asymmetric public key. - https://tools.ietf.org/html/rfc7800#section-3.2 - - - - Returns the formatted string: GetType(), Use: 'value', Kid: 'value', Kty: 'value', InternalId: 'value'. - - string - - - - Converts a into a - Supports: converting to a from one of: , , and . - - - - - Converts a into a - - a to convert. - a - if is null. - if is not a supported type. - Supports: , and . - - - - Converts a into a - - a to convert. - a - if is null. - - - - Converts a into a - - a to convert. - a - if is null. - - - - Converts a into a . - - a to convert. - - true to represent the as an , - false to represent the as an , using the "x5c" parameter. - - a . - if is null. - - - - Converts a into a - - a to convert. - a - if is null. - - - - Constants for JsonWebKey Elliptical Curve Types - https://tools.ietf.org/html/rfc7518#section-6.2.1.1 - - - - - Names for Json Web Key Values - - - - - Contains a collection of that can be populated from a json string. - - provides support for http://tools.ietf.org/html/rfc7517. - - - - Returns a new instance of . - - a string that contains JSON Web Key parameters in JSON format. - - If 'json' is null or empty. - If 'json' fails to deserialize. - - - - Initializes an new instance of . - - - - - Initializes an new instance of from a json string. - - a json string containing values. - If 'json' is null or empty. - If 'json' fails to deserialize. - - - - When deserializing from JSON any properties that are not defined will be placed here. - - - - - Gets the . - - - - - Default value for the flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of method. - - - - - Flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of method. - - - - - Returns the JsonWebKeys as a . - - - To include unresolved JsonWebKeys in the resulting collection, set to false. - - - - - Names for Json Web Key Set Values - - - - - Constants for JsonWebKeyUse (sec 4.2) - http://tools.ietf.org/html/rfc7517#section-4 - - - - - Log messages and codes - - - - - Generic implementation of object pooling pattern with predefined pool size limit. The main - purpose is that limited number of frequently used objects can be kept in the pool for - further recycling. - - Notes: - 1) it is not the goal to keep all returned objects. Pool is not meant for storage. If there - is no space in the pool, extra returned objects will be dropped. - - 2) it is implied that if object was obtained from a pool, the caller will return it back in - a relatively short time. Keeping checked out objects for long durations is ok, but - reduces usefulness of pooling. Just new up your own. - - Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice. - Rationale: - If there is no intent for reusing the object, do not use pool - just use "new". - - - - - Produces an instance. - - - Search strategy is a simple linear probing which is chosen for it cache-friendliness. - Note that Free will try to store recycled objects close to the start thus statistically - reducing how far we will typically search. - - - - - Returns objects to the pool. - - - Search strategy is a simple linear probing which is chosen for it cache-friendliness. - Note that Free will try to store recycled objects close to the start thus statistically - reducing how far we will typically search in Allocate. - - - - - The purpose of this class is to ensure that we obtain an RsaCryptoServiceProvider that supports SHA-256 signatures. - If the original RsaCryptoServiceProvider doesn't support SHA-256, we create a new one using the same KeyContainer. - - - There is no support for and on non-Windows platforms which makes a Windows-specific class. - - - - - Gets the SignatureAlgorithm - - - - - Gets the KeyExchangeAlgorithm - - - - - Initializes an new instance of . - - - if is null. - - - - Decrypts data with the System.Security.Cryptography.RSA algorithm. - - The data to be decrypted. - true to perform direct System.Security.Cryptography.RSA decryption using OAEP padding - (only available on a computer running Microsoft Windows XP or later) otherwise, false to use PKCS#1 v1.5 padding. - decrypted bytes. - if is null or has Length == 0. - - - - Decrypts the input. - - the bytes to decrypt. - decrypted bytes - if is null or Length == 0. - - - - Encrypts data with the System.Security.Cryptography.RSA algorithm. - - The data to be encrypted. - true to perform direct System.Security.Cryptography.RSA encryption using OAEP padding (only available on a computer running Microsoft Windows XP or later); - otherwise, false to use PKCS#1 v1.5 padding. - encrypted bytes. - if is null or has Length == 0. - - - - Encrypts the input. - - the bytes to encrypt. - encrypted bytes. - if is null or Length == 0. - - - - Computes the hash value of the specified byte array using the specified hash algorithm, and signs the resulting hash value. - - The input byte array for which to compute the hash. - The hash algorithm to use to create the hash value. - The Signature for the specified data. - if is null or Length == 0. - if is null. - - - - Verifies that a digital signature is valid by determining the hash value in the signature using the provided public key and comparing it to the hash value of the provided data. - - The input byte array. - The hash algorithm to use to create the hash value. - The signature byte array to be verified. - true if the signature is valid; otherwise, false. - if is null or Length == 0. - if is null. - if is null or Length == 0. - - - - Exports rsa parameters as - - flag to control is private parameters are included. - - - - - Imports rsa parameters as - - to import. - - - - Calls to release managed resources. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - Represents a Rsa security key. - - - - - Initializes a new instance of the class. - - - - - - Initializes a new instance of the class. - - - - - - Gets a bool indicating if a private key exists. - - true if it has a private key; otherwise, false. - - - - Gets an enum indicating if a private key exists. - - 'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine. - - - - Gets RSA key size. - - - - - used to initialize the key. - - - - - instance used to initialize the key. - - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - Constants for Security Algorithm. - - - - - Base class for Security Key. - - - - - Default constructor - - - - - This must be overridden to get the size of this . - - - - - Gets the key id of this . - - - - - Gets or sets . - - - - - Returns the formatted string: GetType(), KeyId: 'value', InternalId: 'value'. - - string - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - Checks if can perform the cryptographic operation specified by the with this . - - the algorithm to apply. - true if can perform the cryptographic operation sepecified by the with this . - - - - Sets the to value of 's JWK thumbprint if it can be computed, otherwise sets the to . - - - - - Contains information about the keys inside the tokens. - - - - - Base class for security token. - - - - - This must be overridden to get the Id of this . - - - - - This must be overridden to get the issuer of this . - - - - - This must be overridden to get the . - - - - - This must be overridden to get or set the that signed this instance. - - .ValidateToken(...) can this value when a is used to successfully validate a signature. - - - - This must be overridden to get the time when this was Valid. - - - - - This must be overridden to get the time when this is no longer Valid. - - - - - Contains some information which used to create a security token. - - - - - Gets or sets the value of the 'audience' claim. - - - - - Defines the compression algorithm that will be used to compress the JWT token payload. - - - - - Gets or sets the used to create a encrypted security token. - - - - - Gets or sets the value of the 'expiration' claim. This value should be in UTC. - - - - - Gets or sets the issuer of this . - - - - - Gets or sets the time the security token was issued. This value should be in UTC. - - - - - Gets or sets the notbefore time for the security token. This value should be in UTC. - - - - - Gets or sets the token type. - If provided, this will be added as the value for the 'typ' header parameter. In the case of a JWE, this will be added to both the inner (JWS) and the outer token (JWE) header. By default, the value used is 'JWT'. - If also contains 'typ' header claim value, it will override the TokenType provided here. - This value is used only for JWT tokens and not for SAML/SAML2 tokens - - - - - Gets or sets the which represents the claims that will be used when creating a security token. - If both and are set, the claim values in Subject will be combined with the values - in Claims. The values found in Claims take precedence over those found in Subject, so any duplicate - values will be overridden. - - - - - Gets or sets the which contains any custom header claims that need to be added to the JWT token header. - The 'alg', 'kid', 'x5t', 'enc', and 'zip' claims are added by default based on the , - , and/or provided and SHOULD NOT be included in this dictionary as this - will result in an exception being thrown. - These claims are only added to the outer header (in case of a JWE). - - - - - Gets or sets the used to create a security token. - - - - - Gets or sets the . - If both and are set, the claim values in Subject will be combined with the values - in Claims. The values found in Claims take precedence over those found in Subject, so any duplicate - values will be overridden. - - - - - Defines the interface for a Security Token Handler. - - - - - Creates an instance of - - - - - Returns . - - - true if attached; otherwise, false. - - - - Returns . - - - - - - Gets a value indicating whether this handler supports validation of tokens - handled by this instance. - v - 'True' if the instance is capable of SecurityToken - validation. - - - - Gets a value indicating whether the class provides serialization functionality to serialize token handled - by this instance. - - true if the WriteToken method can serialize this token. - - - - This must be overridden to get the System.Type of the SecurityToken this instance handles. - - - - - Indicates whether the is positioned at an element that can be read. - - An reader positioned at a start element. The reader should not be advanced. - 'true' if the token can be read. - - - - Indicates whether the current token string can be read as a token - of the type handled by this instance. - - The token string thats needs to be read. - 'True' if the ReadToken method can parse the token string. - - - - Deserializes from string a token of the type handled by this instance. - - The string to be deserialized. - SecurityToken instance which represents the serialized token. - - - - Gets security token. - - . - SecurityToken instance which represents the serialized token. - - - - Serializes to string a token of the type handled by this instance. - - A token of type TokenType. - The serialized token. - - - - This must be overridden to serialize to XML a token of the type handled by this instance. - - The XML writer. - A token of type . - - - - This must be overridden to deserialize token with the provided . - - . - the current . - SecurityToken instance which represents the serialized token. - - - - This must be overridden to validate a token passed as a string using - - A token of type . - the current . - The token of type that was validated. - - - - Reads and validates a token using a xmlReader and - - A pointing at the start element of the token. - Contains data and information needed for validation. - The that was validated. - - - - Provides signature services, signing and verifying. - - - - - Maintains the number of external references - see: , , - - - - - Initializes a new instance of the class used to create and verify signatures. - - The that will be used for signature operations. - The signature algorithm to apply. - is null. - is null or empty. - - - - Gets the signature algorithm. - - - - - Gets or sets a user context for a . - - This is null by default. This is for use by the application and not used by this SDK. - - - - Gets or sets the that is associated with this - - - - - Calls and - - - - - Can be over written in descendants to dispose of internal components. - - true, if called from Dispose(), false, if invoked inside a finalizer - - - - Gets the . - - - - - For testing purposes - - - - - This must be overridden to produce a signature over the 'input'. - - bytes to sign. - signed bytes - - - Verifies that the over using the - and specified by this - are consistent. - the bytes that were signed. - signature to compare against. - true if the computed signature matches the signature parameter, false otherwise. - - - - Gets or sets a bool indicating if this is expected to create signatures. - - - - - Defines the , algorithm and digest for digital signatures. - - - - - Initializes a new instance of the class. - - that will be used for signing. - Algorithm will be set to . - the 'digest method' if needed may be implied from the algorithm. For example implies Sha256. - if 'key' is null. - if 'algorithm' is null or empty. - - - - Initializes a new instance of the class. - - that will be used for signing. - The signature algorithm to apply. - the 'digest method' if needed may be implied from the algorithm. For example implies Sha256. - if 'certificate' is null. - if 'algorithm' is null or empty. - - - - Initializes a new instance of the class. - - . - The signature algorithm to apply. - the 'digest method' if needed may be implied from the algorithm. For example implies Sha256. - if 'key' is null. - if 'algorithm' is null or empty. - - - - Initializes a new instance of the class. - - . - The signature algorithm to apply. - The digest algorithm to apply. - if 'key' is null. - if 'algorithm' is null or empty. - if 'digest' is null or empty. - - - - Gets the signature algorithm. - - if 'value' is null or empty. - - - - Gets the digest algorithm. - - - - - Users can override the default with this property. This factory will be used for creating signature providers. - - This will have precedence over - - - - Gets the used for signature creation or validation. - - - - - Gets the key id associated with . - - - - - Defines the default set of algorithms this library supports - - - - - Creating a Signature requires the use of a . - This method returns the - that describes the to use when generating a Signature. - - The SignatureAlgorithm in use. - The to use. - if is null or whitespace. - if is not supported. - - - - Creating a Signature requires the use of a . - This method returns the HashAlgorithm string that is associated with a SignatureAlgorithm. - - The SignatureAlgorithm of interest. - if is null or whitespace. - if is not supported. - - - - Checks if an 'algorithm, key' pair is supported. - - the algorithm to check. - the . - true if 'algorithm, key' pair is supported. - - - - Represents a symmetric security key. - - - - - Returns a new instance of instance. - - The byte array of the key. - - - - Gets the key size. - - - - - Gets the byte array of the key. - - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - Provides signing and verifying operations using a and specifying an algorithm. - - - - - This is the minimum .KeySize when creating and verifying signatures. - - - - - Initializes a new instance of the class that uses an to create and / or verify signatures over a array of bytes. - - The that will be used for signature operations. - The signature algorithm to use. - 'key' is null. - 'algorithm' is null or empty. - If and algorithm pair are not supported. - '.KeySize' is smaller than . - - - - Initializes a new instance of the class that uses an to create and / or verify signatures over a array of bytes. - - The that will be used for signature operations. - The signature algorithm to use. - indicates if this will be used to create signatures. - 'key' is null. - 'algorithm' is null or empty. - If and algorithm pair are not supported. - '.KeySize' is smaller than . - - - - Gets or sets the minimum .KeySize"/>. - - 'value' is smaller than . - - - - Called to obtain the byte[] needed to create a - - that will be used to obtain the byte[]. - [] that is used to populated the KeyedHashAlgorithm. - if key is null. - if a byte[] can not be obtained from SecurityKey. - and are supported. - For a .Key is returned - For a Base64UrlEncoder.DecodeBytes is called with if == JsonWebAlgorithmsKeyTypes.Octet - - - - - Returns a . - This method is called just before a cryptographic operation. - This provides the opportunity to obtain the from an object pool. - If this method is overridden, it is importont to override - if custom releasing of the is desired. - - The hash algorithm to use to create the hash value. - The byte array of the key. - An instance of - - - - For testing purposes - - - - - This method is called just after the cryptographic operation. - If was overridden this method can be overridden for - any custom handling such as returning the to an object pool. - - The " in use. - - - - Produces a signature over the 'input' using the and 'algorithm' passed to . - - The bytes to sign. - Signed bytes - 'input' is null. - 'input.Length' == 0. - has been called. - is null. This can occur if a derived type deletes it or does not create it. - Sign is thread safe. - - - - Verifies that a signature created over the 'input' matches the signature. Using and 'algorithm' passed to . - - The bytes to verify. - signature to compare against. - true if computed signature matches the signature parameter, false otherwise. - 'input' is null. - 'signature' is null. - 'input.Length' == 0. - 'signature.Length' == 0. - has been called. - If the internal is null. This can occur if a derived type deletes it or does not create it. - Verify is thread safe. - - - - Verifies that a signature created over the 'input' matches the signature. Using and 'algorithm' passed to . - - The bytes to verify. - signature to compare against. - number of bytes of signature to use. - true if computed signature matches the signature parameter, false otherwise. - 'input' is null. - 'signature' is null. - 'input.Length' == 0. - 'signature.Length' == 0. - 'length < 1' - has been called. - If the internal is null. This can occur if a derived type deletes it or does not create it. - - - - Disposes of internal components. - - true, if called from Dispose(), false, if invoked inside a finalizer. - - - - An opaque context used to store work when working with authentication artifacts. - - - - - Instantiates a new with a default activity ID. - - - - - Instantiates a new with an activity ID. - - - - - Defines properties shared across all security token handlers. - - - - - Default lifetime of tokens created. When creating tokens, if 'expires' and 'notbefore' are both null, - then a default will be set to: expires = DateTime.UtcNow, notbefore = DateTime.UtcNow + TimeSpan.FromMinutes(TokenLifetimeInMinutes). - - - - - Gets and sets the maximum token size in bytes that will be processed. - - 'value' less than 1. - - - - Gets or sets a bool that controls if token creation will set default 'exp', 'nbf' and 'iat' if not specified. - - See: for configuration. - - - - Gets or sets the token lifetime in minutes. - - Used during token creation to set the default expiration ('exp'). - 'value' less than 1. - - - - A class which contains useful methods for processing tokens. - - - - - A URI that represents the JSON XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON array XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON null data type - - When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull - - - - Creates a dictionary from a list of Claim's. - - A list of claims. - A Dictionary representing claims. - - - - Returns all provided in validationParameters. - - A required for validation. - Returns all provided in validationParameters. - - - - Merges claims. If a claim with same type exists in both and , the one in claims will be kept. - - Collection of 's. - Collection of 's. - A Merged list of 's. - - - - Definition for AlgorithmValidator - - The algorithm to validate. - The that signed the . - The being validated. - required for validation. - true if the algorithm is considered valid - - - - Definition for AudienceValidator. - - The audiences found in the . - The being validated. - required for validation. - true if the audience is considered valid. - - - - Definition for IssuerSigningKeyResolver. - - The representation of the token that is being validated. - The that is being validated. It may be null. - A key identifier. It may be null. - required for validation. - A to use when validating a signature. - - - - Definition for IssuerSigningKeyValidator. - - The that signed the . - The being validated. - required for validation. - - - - Definition for IssuerValidator. - - The issuer to validate. - The that is being validated. - required for validation. - The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity". - The delegate should return a non null string that represents the 'issuer'. If null a default value will be used. - - - - Definition for LifetimeValidator. - - The 'notBefore' time found in the . - The 'expiration' time found in the . - The being validated. - required for validation. - - - - Definition for TokenReplayValidator. - - The 'expiration' time found in the . - The being validated. - required for validation. - - - - - Definition for SignatureValidator. - - A securityToken with a signature. - required for validation. - - - - Definition for TokenReader. - - A securityToken with a signature. - required for validation. - - - - Definition for TokenDecryptionKeyResolver. - - The representation of the token to be decrypted. - The to be decrypted. The runtime by default passes null. - A key identifier. It may be null. - required for validation. - A to use when decrypting the token. - - - - Definition for TypeValidator. - - The token type to validate. - The that is being validated. - required for validation. - The actual token type, that may be the same as or a different value if the token type was resolved from a different location. - - - - Contains a set of parameters that are used by a when validating a . - - - - - This is the fallback authenticationtype that a will use if nothing is set. - - - - - Default for the clock skew. - - 300 seconds (5 minutes). - - - - Default for the maximm token size. - - 250 KB (kilobytes). - - - - Copy constructor for . - - - - - Initializes a new instance of the class. - - - - - Gets or sets . - - - - - Gets or sets a delegate used to validate the cryptographic algorithm used. - - - If set, this delegate will validate the cryptographic algorithm used and - the algorithm will not be checked against . - - - - - Gets or sets a delegate that will be used to validate the audience. - - - If set, this delegate will be called to validate the 'audience', instead of normal processing. This means that no default 'audience' validation will occur. - Even if is false, this delegate will still be called. - - - - - Gets or sets the AuthenticationType when creating a . - - If 'value' is null or whitespace. - - - - Gets or sets the clock skew to apply when validating a time. - - If 'value' is less than 0. - - - - Returns a new instance of with values copied from this object. - - A new object copied from this object - This is a shallow Clone. - - - - Creates a using: - - 'NameClaimType': If NameClaimTypeRetriever is set, call delegate, else call NameClaimType. If the result is a null or empty string, use . - 'RoleClaimType': If RoleClaimTypeRetriever is set, call delegate, else call RoleClaimType. If the result is a null or empty string, use . - - A with Authentication, NameClaimType and RoleClaimType set. - - - - Users can override the default with this property. This factory will be used for creating signature providers. - - - - - Gets or sets a boolean that controls if a '/' is significant at the end of the audience. - - - - - Gets or sets a delegate for validating the that signed the token. - - - If set, this delegate will be called to validate the that signed the token, instead of normal processing. This means that no default validation will occur. - Even if is false, this delegate will still be called. - - - - - Gets or sets the that is to be used for signature validation. - - - - - Gets or sets a delegate that will be called to retrieve a used for signature validation. - - - This will be used to check the signature. This can be helpful when the does not contain a key identifier. - - - - - Gets or sets an used for signature validation. - - - - - Gets or sets a delegate that will be used to validate the issuer of the token. - - - If set, this delegate will be called to validate the 'issuer' of the token, instead of normal processing. This means that no default 'issuer' validation will occur. - Even if is false, this delegate will still be called. - - - - - Gets or sets a delegate that will be used to validate the lifetime of the token - - - If set, this delegate will be called to validate the lifetime of the token, instead of normal processing. This means that no default lifetime validation will occur. - Even if is false, this delegate will still be called. - - - - - Gets or sets a that defines the . - - - Controls the value returns. It will return the first where the equals . - - - - - Gets or sets a delegate that will be called to obtain the NameClaimType to use when creating a ClaimsIdentity - after validating a token. - - - - - Gets or sets the that contains a collection of custom key/value pairs. This allows addition of parameters that could be used in custom token validation scenarios. - - - - - Gets or sets a value indicating whether SAML tokens must have at least one AudienceRestriction. - - - - - Gets or sets a value indicating whether tokens must have an 'expiration' value. - - - - - Gets or sets a value indicating whether a can be considered valid if not signed. - - - - - Gets or sets the that defines the . - - - Controls the results of . - Each where == will be checked for a match against the 'string' passed to . - - - - - Gets or sets a delegate that will be called to obtain the RoleClaimType to use when creating a ClaimsIdentity - after validating a token. - - - - - Gets or sets a boolean to control if the original token should be saved after the security token is validated. - - The runtime will consult this value and save the original token that was validated. - - - - Gets or sets a delegate that will be used to validate the signature of the token. - - - If set, this delegate will be called to signature of the token, instead of normal processing. - - - - - Gets or sets the that is to be used for decryption. - - - - - Gets or sets a delegate that will be called to retreive a used for decryption. - - - This will be used to decrypt the token. This can be helpful when the does not contain a key identifier. - - - - - Gets or sets the that is to be used for decrypting inbound tokens. - - - - - Gets or sets a delegate that will be used to read the token. - - - If set, this delegate will be called to read the token instead of normal processing. - - - - - Gets or set the that store tokens that can be checked to help detect token replay. - - If set, then tokens must have an expiration time or the runtime will fault. - - - - Gets or sets a delegate that will be used to validate the token replay of the token - - - If set, this delegate will be called to validate the token replay of the token, instead of normal processing. This means no default token replay validation will occur. - Even if is false, this delegate will still be called. - - - - - Gets or sets a value indicating whether all should be tried during signature validation when a key is not matched to token kid or if token kid is empty. - - - - - Gets or sets a delegate that will be used to validate the type of the token. - If the token type cannot be validated, an exception MUST be thrown by the delegate. - Note: the 'type' parameter may be null if it couldn't be extracted from its usual location. - Implementations that need to resolve it from a different location can use the 'token' parameter. - - - If set, this delegate will be called to validate the 'type' of the token, instead of normal processing. - This means that no default 'type' validation will occur. - - - - - Gets or sets a value indicating if an actor token is detected, whether it should be validated. - - - - - Gets or sets a boolean to control if the audience will be validated during token validation. - - Validation of the audience, mitigates forwarding attacks. For example, a site that receives a token, could not replay it to another side. - A forwarded token would contain the audience of the original site. - This boolean only applies to default audience validation. If is set, it will be called regardless of whether this - property is true or false. - - - - Gets or sets a boolean to control if the issuer will be validated during token validation. - - - Validation of the issuer mitigates forwarding attacks that can occur when an - IdentityProvider represents multiple tenants and signs tokens with the same keys. - It is possible that a token issued for the same audience could be from a different tenant. For example an application could accept users from - contoso.onmicrosoft.com but not fabrikam.onmicrosoft.com, both valid tenants. An application that accepts tokens from fabrikam could forward them - to the application that accepts tokens for contoso. - This boolean only applies to default issuer validation. If is set, it will be called regardless of whether this - property is true or false. - - - - - Gets or sets a boolean that controls if validation of the that signed the securityToken is called. - - It is possible for tokens to contain the public key needed to check the signature. For example, X509Data can be hydrated into an X509Certificate, - which can be used to validate the signature. In these cases it is important to validate the SigningKey that was used to validate the signature. - This boolean only applies to default signing key validation. If is set, it will be called regardless of whether this - property is true or false. - - - - - Gets or sets a boolean to control if the lifetime will be validated during token validation. - - - This boolean only applies to default lifetime validation. If is set, it will be called regardless of whether this - property is true or false. - - - - - Gets or sets a boolean to control if the token replay will be validated during token validation. - - - This boolean only applies to default token replay validation. If is set, it will be called regardless of whether this - property is true or false. - - - - - Gets or sets the valid algorithms for cryptographic operations. - - - If set to a non-empty collection, only the algorithms listed will be considered valid. - - - - - Gets or sets a string that represents a valid audience that will be used to check against the token's audience. - - - - - Gets or sets the that contains valid audiences that will be used to check against the token's audience. - - - - - Gets or sets a that represents a valid issuer that will be used to check against the token's issuer. - - - - - Gets or sets the that contains valid issuers that will be used to check against the token's issuer. - - - - - Gets or sets the that contains valid types that will be used to check against the JWT header's 'typ' claim. - If this property is not set, the 'typ' header claim will not be validated and all types will be accepted. - In the case of a JWE, this property will ONLY apply to the inner token header. - - - - - Contains artifacts obtained when a SecurityToken is validated. - - - - - The created from the validated security token. - - - - - The created from the validated security token. - - - - - Gets or sets the that occurred during validation. - - - - - Gets or sets the issuer that was found in the token. - - - - - True if the token was successfully validated, false otherwise. - - - - - Gets or sets the that contains a collection of custom key/value pairs. This allows addition of data that could be used in custom scenarios. This uses for case-sensitive comparison of keys. - - - - - Gets or sets the that was validated. - - - - - Gets or sets the that contains call information. - - - - - Gets or sets the token type of the that was validated. - When a is registered, - the type returned by the delegate is used to populate this property. - Otherwise, the type is resolved from the token itself, if available - (e.g for a JSON Web Token, from the "typ" header). - - - - - Generates unique IDs. - - - - - Creates a unique ID suitable for use in an xml:id field. The value is - not hard to guess but is unique. - - The unique ID. - - - - Creates a unique ID similar to that created by CreateNonRandomId, - but instead of an underscore, the supplied prefix is used. - - The prefix to use. - The unique ID, with the given prefix. - - - - Creates a unique, random ID suitable for use in an xml:id field. The - value is hard to guess and unique. - - The unique ID. - - - - Creates a unique, random ID similar to that created by CreateRandomId, - but instead of an underscore, the supplied prefix is used. - - The prefix to use. - The random URI. - - - - Creates a unique, random ID suitable for use as a URI. The value is - hard to guess and unique. The URI is in the urn:uuid: namespace. - - The random URI. - - - - Contains some utility methods. - - - - - A string with "empty" value. - - - - - A string with "null" value. - - - - - Creates a copy of the byte array. - - The resource array. - A copy of the byte array. - - - - Serializes the list of strings into string as follows: - 'str1','str2','str3' ... - - - The strings used to build a comma delimited string. - - - The single . - - - - - Returns whether the input string is https. - - The input string. - true if the input string is https; otherwise, false. - - - - Returns whether the input uri is https. - - . - true if the input uri is https; otherwise, false. - - - - Compares two byte arrays for equality. Hash size is fixed normally it is 32 bytes. - The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents. - - - One set of bytes to compare. - - - The other set of bytes to compare with. - - - true if the bytes are equal, false otherwise. - - - - - Compares two byte arrays for equality. Hash size is fixed normally it is 32 bytes. - The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents. - - - One set of bytes to compare. - - - The other set of bytes to compare with. - - length of array to check - - true if the bytes are equal, false otherwise. - - - - - AudienceValidator - - - - - Validates if a given algorithm for a is valid. - - The algorithm to be validated. - The that signed the . - The being validated. - required for validation. - - - - Determines if the audiences found in a are valid. - - The audiences found in the . - The being validated. - required for validation. - If 'vaidationParameters' is null. - If 'audiences' is null and is true. - If is null or whitespace and is null. - If none of the 'audiences' matched either or one of . - An EXACT match is required. - - - - Determines if an issuer found in a is valid. - - The issuer to validate - The that is being validated. - required for validation. - The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity". - If 'vaidationParameters' is null. - If 'issuer' is null or whitespace and is true. - If is null or whitespace and is null. - If 'issuer' failed to matched either or one of . - An EXACT match is required. - - - - Validates the that signed a . - - The that signed the . - The being validated. - required for validation. - if 'securityKey' is null and ValidateIssuerSigningKey is true. - if 'securityToken' is null and ValidateIssuerSigningKey is true. - if 'vaidationParameters' is null. - - - - Validates the lifetime of a . - - The 'notBefore' time found in the . - The 'expiration' time found in the . - The being validated. - required for validation. - If 'vaidationParameters' is null. - If 'expires.HasValue' is false and is true. - If 'notBefore' is > 'expires'. - If 'notBefore' is > DateTime.UtcNow. - If 'expires' is < DateTime.UtcNow. - All time comparisons apply . - - - - Validates if a token has been replayed. - - When does the security token expire. - The being validated. - required for validation. - If 'securityToken' is null or whitespace. - If 'validationParameters' is null or whitespace. - If is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time. - If the 'securityToken' is found in the cache. - If the 'securityToken' could not be added to the . - - - - Validates if a token has been replayed. - - The being validated. - When does the security token expire. - required for validation. - If 'securityToken' is null or whitespace. - If 'validationParameters' is null or whitespace. - If is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time. - If the 'securityToken' is found in the cache. - If the 'securityToken' could not be added to the . - - - - Validates the type of the token. - - The token type or null if it couldn't be resolved (e.g from the 'typ' header for a JWT). - The that is being validated. - required for validation. - If is null. - If is null. - If is null or whitespace and is not null. - If failed to match . - An EXACT match is required. (case sensitive) is used for comparing against . - The actual token type, that may be the same as or a different value if the token type was resolved from a different location. - - - - An designed to construct based on a x509 certificate. - - - - - Designed to construct based on a x509 certificate. - - A - - will be used as the key wrap algorithm - will be used as the data encryption algorithm - - if 'certificate' is null. - - - - Designed to construct based on the x509 certificate, a key wrap algorithm, and data encryption algorithm. - - A - A key wrap algorithm - Data encryption algorithm - if 'certificate' is null. - if 'keyWrapAlgorithm' is null or empty. - if 'dataEncryptionAlgorithm' is null or empty. - - - - Gets the used by this instance. - - - - - An that is backed by a - - - - - Instantiates a using a - - The to use. - if is null. - - - - Instantiates a using a . - - The to use. - The value to set for the KeyId - if is null. - if is null or empty. - - - - Gets the key size. - - - - - Gets the X5t of this . - - - - - Returns the private key from the . - - - - - Gets the public key from the . - - - - - Gets a bool indicating if a private key exists. - - true if it has a private key; otherwise, false. - - - - Gets an enum indicating if a private key exists. - - 'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine. - - - - Gets the . - - - - - Determines whether the can compute a JWK thumbprint. - - true if JWK thumbprint can be computed; otherwise, false. - https://tools.ietf.org/html/rfc7638 - - - - Computes a sha256 hash over the . - - A JWK thumbprint. - https://tools.ietf.org/html/rfc7638 - - - - Returns a bool indicating if this key is equivalent to another key. - - true if the keys are equal; otherwise, false. - - - - Returns an int hash code. - - An int hash code - - - - Defines the , algorithm and digest for digital signatures. - - - - - Initializes a new instance of the class. - - that will be used for signing. - Algorithm will be set to . - the 'digest method' if needed may be implied from the algorithm. For example implies Sha256. - if 'certificate' is null. - - - - Initializes a new instance of the class. - - A that will be used for signing. - The signature algorithm to apply. - the 'digest method' if needed may be implied from the algorithm. For example implies Sha256. - if 'certificate' is null. - if 'algorithm' is null or empty. - - - - Gets the used by this instance. - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets the string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets the string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - - The JSON line info handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JPath expression. Selects the token that matches the object path. - - - A that contains a JPath expression. - - A , or null. - - - - Selects a using a JPath expression. Selects the token that matches the object path. - - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JPath expression. - - - A that contains a JPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JPath expression. - - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Microsoft.IdentityModel.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the member is an indexed property. - - The member. - - true if the member is an indexed property; otherwise, false. - - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml.meta deleted file mode 100644 index d21cb995..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Microsoft.IdentityModel.Tokens.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: f88bb043824d46742a5db2b48da5e07b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.dll.meta deleted file mode 100644 index 7a4961a9..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 748434f15ec88b646bd6776399bc597b -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml deleted file mode 100644 index ae2077ff..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml +++ /dev/null @@ -1,518 +0,0 @@ - - - - Serilog.Sinks.File - - - - Extends with methods to add file sinks. - - - - Write log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - Write log events to the specified file. - - Logger sink configuration. - A formatter, such as , to convert the log events into - text for the file. If control of regular text formatting is required, use the other - overload of - and specify the outputTemplate parameter instead. - - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - Write log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - The interval at which logging will roll over to a new file. - If true, a new file will be created when the file size limit is reached. Filenames - will have a number appended in the format _NNN, with the first filename given no number. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Configuration object allowing method chaining. - - - - Write log events to the specified file. - - Logger sink configuration. - A formatter, such as , to convert the log events into - text for the file. If control of regular text formatting is required, use the other - overload of - and specify the outputTemplate parameter instead. - - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - The interval at which logging will roll over to a new file. - If true, a new file will be created when the file size limit is reached. Filenames - will have a number appended in the format _NNN, with the first filename given no number. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Configuration object allowing method chaining. - - - - Write log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - The interval at which logging will roll over to a new file. - If true, a new file will be created when the file size limit is reached. Filenames - will have a number appended in the format _NNN, with the first filename given no number. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Optionally enables hooking into log file lifecycle events. - The maximum time after the end of an interval that a rolling log file will be retained. - Must be greater than or equal to . - Ignored if is . - The default is to retain files indefinitely. - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Write log events to the specified file. - - Logger sink configuration. - A formatter, such as , to convert the log events into - text for the file. If control of regular text formatting is required, use the other - overload of - and specify the outputTemplate parameter instead. - - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Allow the log file to be shared by multiple processes. The default is false. - If provided, a full disk flush will be performed periodically at the specified interval. - The interval at which logging will roll over to a new file. - If true, a new file will be created when the file size limit is reached. Filenames - will have a number appended in the format _NNN, with the first filename given no number. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Optionally enables hooking into log file lifecycle events. - The maximum time after the end of an interval that a rolling log file will be retained. - Must be greater than or equal to . - Ignored if is . - The default is to retain files indefinitely. - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Write log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Write log events to the specified file. - - Logger sink configuration. - A formatter, such as , to convert the log events into - text for the file. If control of regular text formatting is required, use the other - overload of - and specify the outputTemplate parameter instead. - - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - When is null - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Write audit log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". - Character encoding used to write the text file. The default is UTF-8 without BOM. - Optionally enables hooking into log file lifecycle events. - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Write audit log events to the specified file. - - Logger sink configuration. - A formatter, such as , to convert the log events into - text for the file. If control of regular text formatting is required, use the other - overload of - and specify the outputTemplate parameter instead. - - Path to the file. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Optionally enables hooking into log file lifecycle events. - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Specifies the frequency at which the log file should roll. - - - - - The log file will never roll; no time period information will be appended to the log file name. - - - - - Roll every year. Filenames will have a four-digit year appended in the pattern yyyy. - - - - - Roll every calendar month. Filenames will have yyyyMM appended. - - - - - Roll every day. Filenames will have yyyyMMdd appended. - - - - - Roll every hour. Filenames will have yyyyMMddHH appended. - - - - - Roll every minute. Filenames will have yyyyMMddHHmm appended. - - - - - Enables hooking into log file lifecycle events. - Hooks run synchronously and therefore may affect responsiveness of the application if long operations are performed. - - - - - Initialize or wrap the opened on the log file. This can be used to write - file headers, or wrap the stream in another that adds buffering, compression, encryption, etc. The underlying - file may or may not be empty when this method is called. - - - A value must be returned from overrides of this method. Serilog will flush and/or dispose the returned value, but will not - dispose the stream initially passed in unless it is itself returned. - - The full path to the log file. - The underlying opened on the log file. - The encoding to use when reading/writing to the stream. - The Serilog should use when writing events to the log file. - - - - Initialize or wrap the opened on the log file. This can be used to write - file headers, or wrap the stream in another that adds buffering, compression, encryption, etc. The underlying - file may or may not be empty when this method is called. - - - A value must be returned from overrides of this method. Serilog will flush and/or dispose the returned value, but will not - dispose the stream initially passed in unless it is itself returned. - - The underlying opened on the log file. - The encoding to use when reading/writing to the stream. - The Serilog should use when writing events to the log file. - - - - Called before an obsolete (rolling) log file is deleted. - This can be used to copy old logs to an archive location or send to a backup server. - - The full path to the file being deleted. - - - - Creates a chain of that have their methods called sequentially - Can be used to compose together; e.g. add header information to each log file and - compress it. - - - - var hooks = new GZipHooks().Then(new HeaderWriter("File Header")); - - - The next to have its methods called in the chain - - - - - Write log events to a disk file. - - - - Construct a . - Path to the file. - Formatter used to convert log events to text. - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Indicates if flushing to the output file can be buffered or not. The default - is false. - Configuration object allowing method chaining. - This constructor preserves compatibility with early versions of the public API. New code should not depend on this type. - When is null - When is null or less than 0 - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Emit the provided log event to the sink. - - The log event to write. - When is null - - - - - - - - - - Exists only for the convenience of , which - switches implementations based on sharing. Would refactor, but preserving - backwards compatibility. - - - - - Supported by (file-based) sinks that can be explicitly flushed. - - - - - Flush buffered contents to disk. - - - - - An instance of this sink may be substituted when an instance of the - is unable to be constructed. - - - - - A sink wrapper that periodically flushes the wrapped sink to disk. - - - - - Construct a that wraps - and flushes it at the specified . - - The sink to wrap. - The interval at which to flush the underlying sink. - When is null - - - - - - - - - - Write log events to a disk file. - - - - Construct a . - Path to the file. - Formatter used to convert log events to text. - The approximate maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. To avoid writing partial events, the last event within the limit - will be written in full even if it exceeds the limit. - Character encoding used to write the text file. The default is UTF-8 without BOM. - Configuration object allowing method chaining. - When is null - When is null - - - - When is too long - The caller does not have the required permission to access the - Invalid - - - - Emit the provided log event to the sink. - - The log event to write. - When is null - - - - - - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml.meta deleted file mode 100644 index ceaddcb4..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.Sinks.File.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b662da69db620a04f8130a7b974c272a -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.dll.meta deleted file mode 100644 index beeec0a7..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: 2715317a1abecbe44affbaa5835c3f0f -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml deleted file mode 100644 index 415bdc3e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml +++ /dev/null @@ -1,4783 +0,0 @@ - - - - Serilog - - - - - Create properties based on an ordered list of provided values. - - The template that the parameters apply to. - Objects corresponding to the properties - represented in the message template. - A list of properties; if the template is malformed then - this will be empty. - - - - Implemented on types that apply settings to a logger configuration. - - - - - Apply the settings to the logger configuration. - - The logger configuration to apply settings to. - - - - Controls audit sink configuration. - - - - - Audit log events to the specified . - - The sink. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - - - - Audit log events to the specified . - - The sink. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - - - - Audit log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - An action that configures the sub-logger. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - - - - Audit log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - The sub-logger. This will not be shut down automatically when the - parent logger is disposed. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Controls template parameter destructuring configuration. - - - - - Treat objects of the specified type as scalar values, i.e., don't break - them down into properties event when destructuring complex types. - - Type to treat as scalar. - Configuration object allowing method chaining. - When is null - - - - Treat objects of the specified type as scalar values, i.e., don't break - them down into properties event when destructuring complex types. - - Type to treat as scalar. - Configuration object allowing method chaining. - - - - When destructuring objects, transform instances with the provided policies. - - Policies to apply when destructuring. - Configuration object allowing method chaining. - When is null - When any element of is null - - - - When destructuring objects, transform instances with the provided policy. - - Policy to apply when destructuring. - Configuration object allowing method chaining. - - - - When destructuring objects, transform instances of the specified type with - the provided function. - - Function mapping instances of - to an alternative representation. - Type of values to transform. - Configuration object allowing method chaining. - When is null - - - - When destructuring objects, transform instances of the specified type with - the provided function, if the predicate returns true. Be careful to avoid any - intensive work in the predicate, as it can slow down the pipeline significantly. - - A predicate used to determine if the transform applies to - a specific type of value - Function mapping instances of - to an alternative representation. - Type of values to transform. - Configuration object allowing method chaining. - When is null - When is null - - - - When destructuring objects, depth will be limited to 10 property traversals deep to - guard against ballooning space when recursive/cyclic structures are accidentally passed. To - change this limit pass a new maximum depth. - - The maximum depth to use. - Configuration object allowing method chaining. - When is negative - - - - When destructuring objects, string values can be restricted to specified length - thus avoiding bloating payload. Limit is applied to each value separately, - sum of length of strings can exceed limit. - - The maximum string length. - Configuration object allowing method chaining. - When is less than 2 - - - - When destructuring objects, collections be restricted to specified count - thus avoiding bloating payload. Limit is applied to each collection separately, - sum of length of collection can exceed limit. - Applies limit to all including dictionaries. - - Configuration object allowing method chaining. - When is less than 1 - - - - Controls enrichment configuration. - - - - - Specifies one or more enrichers that may add properties dynamically to - log events. - - Enrichers to apply to all events passing through - the logger. - Configuration object allowing method chaining. - When is null - When any element of is null - - - - Specifies an enricher that may add properties dynamically to - log events. - - Enricher type to apply to all events passing through - the logger. - Configuration object allowing method chaining. - - - - Include the specified property value in all events logged to the logger. - - The name of the property to add. - The property value to add. - If true, objects of unknown type will be logged as structures; otherwise they will be converted using . - Configuration object allowing method chaining. - - - - Enrich log events with properties from . - - Configuration object allowing method chaining. - - Configuration object allowing method chaining. - - - - Apply an enricher only when evaluates to true. - - A predicate that evaluates to true when the supplied - should be enriched. - An action that configures the wrapped enricher. - Configuration object allowing method chaining. - When is null - When is null - - - - Apply an enricher only to events with a greater than or equal to . - - The level from which the enricher will be applied. - An action that configures the wrapped enricher. - Configuration object allowing method chaining. - This method permits additional information to be attached to e.g. warnings and errors, that might be too expensive - to collect or store at lower levels. - When is null - - - - Apply an enricher only to events with a greater than or equal to the level specified by . - - A that specifies the level from which the enricher will be applied. - An action that configures the wrapped enricher. - Configuration object allowing method chaining. - This method permits additional information to be attached to e.g. warnings and errors, that might be too expensive - to collect or store at lower levels. - When is null - - - - Helper method for wrapping sinks. - - The parent enrichment configuration. - A function that allows for wrapping s - added in . - An action that configures enrichers to be wrapped in . - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - Controls filter configuration. - - - - - Filter out log events from the stream based on the provided filter. - - The filters to apply. - Configuration object allowing method chaining. - When is null - When any element of is null - - - - Filter out log events from the stream based on the provided filter. - - The filters to apply. - Configuration object allowing method chaining. - - - - Filter out log events that match a predicate. - - Function that returns true when an event - should be excluded (silenced). - Configuration object allowing method chaining. - - - - Filter log events to include only those that match a predicate. - - Function that returns true when an event - should be included (emitted). - Configuration object allowing method chaining. - - - - Controls sink configuration. - - - - - Sets the minimum level at which events will be passed to sinks. - - The minimum level to set. - Configuration object allowing method chaining. - - - - Sets the minimum level to be dynamically controlled by the provided switch. - - The switch. - Configuration object allowing method chaining. - When is null - - - - Anything and everything you might want to know about - a running block of code. - - Configuration object allowing method chaining. - - - - Internal system events that aren't necessarily - observable from the outside. - - Configuration object allowing method chaining. - - - - The lifeblood of operational intelligence - things - happen. - - Configuration object allowing method chaining. - - - - Service is degraded or endangered. - - Configuration object allowing method chaining. - - - - Functionality is unavailable, invariants are broken - or data is lost. - - Configuration object allowing method chaining. - - - - If you have a pager, it goes off when one of these - occurs. - - Configuration object allowing method chaining. - - - - Override the minimum level for events from a specific namespace or type name. - This API is not supported for configuring sub-loggers (created through ). Use or instead. - You also might consider using https://github.com/serilog/serilog-filters-expressions. - - The (partial) namespace or type name to set the override for. - The switch controlling loggers for matching sources. - Configuration object allowing method chaining. - When is null - When a trimmed is empty - When is null - - - - Override the minimum level for events from a specific namespace or type name. - This API is not supported for configuring sub-loggers (created through ). Use or instead. - You also might consider using https://github.com/serilog/serilog-filters-expressions. - - The (partial) namespace or type name to set the override for. - The minimum level applied to loggers for matching sources. - Configuration object allowing method chaining. - When is null - - - - Allows additional setting sources to drive the logger configuration. - - - - - Apply external settings to the logger configuration. - - Configuration object allowing method chaining. - When is null - - - - Apply settings specified in the Serilog key-value setting format to the logger configuration. - - A list of key-value pairs describing logger settings. - Configuration object allowing method chaining. - In case of duplicate keys, the last value for the key is kept and the previous ones are ignored. - When is null - - - - Controls sink configuration. - - - - - Write log events to the specified . - - The sink. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - Provided for binary compatibility for earlier versions, - should be removed in 3.0. Not marked obsolete because warnings - would be syntactically annoying to avoid. - - - - Write log events to the specified . - - The sink. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - - - - Write log events to the specified . - - The sink. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. - Configuration object allowing method chaining. - - - - Write log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - An action that configures the sub-logger. - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. Can be null - Configuration object allowing method chaining. - When is null - - - - Write log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - The sub-logger. This will not be shut down automatically when the - parent logger is disposed. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - When is null - - - - Write to a sink only when evaluates to true. - - A predicate that evaluates to true when the supplied - should be written to the configured sink. - An action that configures the wrapped sink. - Configuration object allowing method chaining. - When is null - When is null - - - - Helper method for wrapping sinks. - - The parent sink configuration. - A function that allows for wrapping s - added in . - An action that configures sinks to be wrapped in . - Configuration object allowing method chaining. - - - - Helper method for wrapping sinks. - - The parent sink configuration. - A function that allows for wrapping s - added in . - An action that configures sinks to be wrapped in . - The minimum level for - events passed through the sink. Ignored when is specified. - A switch allowing the pass-through minimum level - to be changed at runtime. Can be null - Configuration object allowing method chaining. - When is null - When is null - When is null - - - - Holds ambient properties that can be attached to log events. To - configure, use the method. - - - Configuration: - - var log = new LoggerConfiguration() - .Enrich.FromLogContext() - ... - - Usage: - - using (LogContext.PushProperty("MessageId", message.Id)) - { - Log.Information("The MessageId property will be attached to this event"); - } - - - The scope of the context is the current logical thread, using AsyncLocal - (and so is preserved across async/await calls). - - - - Push a property onto the context, returning an - that must later be used to remove the property, along with any others that - may have been pushed on top of it and not yet popped. The property must - be popped from the same thread/logical call context. - - The name of the property. - The value of the property. - A handle to later remove the property from the context. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - A token that must be disposed, in order, to pop properties back off the stack. - - - - Push an enricher onto the context, returning an - that must later be used to remove the property, along with any others that - may have been pushed on top of it and not yet popped. The property must - be popped from the same thread/logical call context. - - An enricher to push onto the log context - A token that must be disposed, in order, to pop properties back off the stack. - When is null - - - - Push multiple enrichers onto the context, returning an - that must later be used to remove the property, along with any others that - may have been pushed on top of it and not yet popped. The property must - be popped from the same thread/logical call context. - - . - Enrichers to push onto the log context - A token that must be disposed, in order, to pop properties back off the stack. - When is null - - - - Push enrichers onto the log context. This method is obsolete, please - use instead. - - Enrichers to push onto the log context - A token that must be disposed, in order, to pop properties back off the stack. - - - - - Obtain an enricher that represents the current contents of the . This - can be pushed back onto the context in a different location/thread when required. - - An enricher that represents the current contents of the . - - - - Remove all enrichers from the , returning an - that must later be used to restore enrichers that were on the stack before was called. - - A token that must be disposed, in order, to restore properties back to the stack. - - - - Remove all enrichers from for the current async scope. - - - - - Constants used in the core logging pipeline and associated types. - - - - - The name of the property included in the emitted log events - when ForContext<T>() and overloads are - applied. - - - - - Adds a new property enricher to the log event. - - - - - Create a new property enricher. - - The name of the property. - The value of the property. - A handle to later remove the property from the context. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - - When is null - When is empty or only contains whitespace - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - When is null - When is null - - - - Determine how, when destructuring, a supplied value is represented - as a complex log event property. - - - - - If supported, destructure the provided value. - - The value to destructure. - Recursively apply policies to destructure additional values. - The destructured value, or null. - True if the value could be destructured under this policy. - - - - Applied during logging to add additional information to log events. - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - Provides filtering of the log event stream. - - - - - Returns true if the provided event is enabled. Otherwise, false. - - The event to test. - True if the event is enabled by this filter. If false - is returned, the event will not be emitted. - - - - Creates log event properties from regular .NET objects, applying policies as - required. - - - - - Construct a with the specified name and value. - - The name of the property. - The value of the property. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - - - - - Supports the policy-driven construction of s given - regular .NET objects. - - - - - Create a given a .NET object and destructuring - strategy. - - The value of the property. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - The value. - - - - A destination for log events. - - - - - Emit the provided log event to the sink. - - The log event to write. - - - - Determine how a simple value is carried through the logging - pipeline as an immutable . - - - - - If supported, convert the provided value into an immutable scalar. - - The value to convert. - The converted value, or null. - True if the value could be converted under this policy. - - - - The core Serilog logging pipeline. A must - be disposed to flush any events buffered within it. Most application - code should depend on , not this class. - - - - - Create a logger that enriches log events via the provided enrichers. - - Enricher that applies in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events via the provided enrichers. - - Enrichers that apply in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events with the specified property. - - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - - - - - - Determine if events at the specified level, and higher, will be passed through - to the log sinks. - - Level to check. - True if the level is enabled; otherwise, false. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Write an event to the log. - - The event to write. - - - - Write a log event with the level. - - Message template describing the event. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Uses configured scalar conversion and destructuring rules to bind a set of properties to a - message template. Returns false if the template or values are invalid (ILogger - methods never throw exceptions). - - Message template describing an event. - Objects positionally formatted into the message template. - The internal representation of the template, which may be used to - render the as text. - Captured properties from the template and . - - MessageTemplate template; - IEnumerable<LogEventProperty> properties>; - if (Log.BindMessageTemplate("Hello, {Name}!", new[] { "World" }, out template, out properties) - { - var propsByName = properties.ToDictionary(p => p.Name, p => p.Value); - Console.WriteLine(template.Render(propsByName, null)); - // -> "Hello, World!" - } - - - - - Uses configured scalar conversion and destructuring rules to bind a property value to its captured - representation. - - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - The resulting property. - True if the property could be bound, otherwise false (ILogger - methods never throw exceptions). - - - - Close and flush the logging pipeline. - - - - - An instance that efficiently ignores all method calls. - - - - - Dynamically controls logging level. - - - - - Create a at the initial - minimum level. - - The initial level to which the switch is set. - - - - The current minimum level, below which no events - should be generated. - - - - - Indicates that the marked method logs data using a message template and (optional) arguments. - The name of the parameter which contains the message template should be given in the constructor. - - - - [LoggerMethod("messageTemplate")] - public void Information(string messageTemplate, params object[] propertyValues) - { - // Do something - } - - public void Foo() - { - Information("Hello, {Name}!") // Warning: Non-existing argument in message template. - } - - - - - - Initializes a new instance of the class. - - Name of the message template parameter. - - - - Gets the name of the message template parameter. - - The name of the message template parameter. - - - - Forwards log events to another logging pipeline. Copies the events so - that mutations performed on the copies do not affect the originals. - - The properties dictionary is copied, however the values within - the dictionary (of type are expected to - be immutable. - - - - A base class for visitors that rewrite the value with modifications. For example, implementations - might remove all structure properties with a certain name, apply size/length limits, or convert scalar properties of - one type into scalar properties of another. - - - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value of an unsupported type. Returns the value unchanged. - - Operation state. - The value to visit. - The result of visiting . - - - - An abstract base class for visitors that walk data in the - format. Subclasses, by - overriding appropriate methods, may search for, transform, - or print the value structures being visited. - - - Stateless, designed to accommodate allocation-free visiting of multiple - values by the same visitor instance. - - The type of a state object passed through - the visiting process. - The type of the result generated by visiting - a node. - - - - Visit the root node type. This method delegates to - a concrete Visit*Value() method appropriate for the value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Visit a value of an unsupported type. Always throws , when is not overridden. - - Operation state. - The value to visit. - The result of visiting . - When is null - Always - - - - May be thrown by log event sinks when a failure occurs. Should not be used in cases - where the exception would propagate out to callers. - - - - - Construct a to communicate a logging failure. - - A message describing the logging failure. - - - - A simple source of information generated by Serilog itself, - for example when exceptions are thrown and caught internally. - - - - - The output mechanism for self-log messages. - - - SelfLog.Out = Console.Error; - - - - - Set the output mechanism for self-log messages. - - A synchronized to which - self-log messages will be written. - When is null - - - - Set the output mechanism for self-log messages. - - An action to invoke with self-log messages. - // ReSharper disable once MemberCanBePrivate.Global - When is null - - - - Clear the output mechanism and disable self-log events. - - // ReSharper disable once MemberCanBePrivate.Global - - - - Write a message to the self-log. - - Standard .NET format string containing the message. - First argument, if supplied. - Second argument, if supplied. - Third argument, if supplied. - - The name is historical; because this is used from third-party sink packages, removing the "Line" - suffix as would seem sensible isn't worth the breakage. - - - - - A value represented as a mapping from keys to values. - - - - - Create a with the provided . - - The key-value mappings represented in the dictionary. - When is null - - - - The dictionary mapping. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - When is null - - - - A property associated with a . - - This type is currently internal, while we consider future directions for the logging pipeline, but should end up public - in future. - - - - No property. - - - - - The name of the property. - - - - - The value of the property. - - - - - Construct a with the specified name and value. - - The name of the property. - The value of the property. - When is null - When is empty or only contains whitespace - When is null - - - - Permit deconstruction of the property into a name/value pair. - - The name of the property. - The value of the property. - - - - - - Indicates whether this instance and a specified are equal. - The to compare with the current instance. - - if and this instance represent the same value; otherwise, . - - - - - - - Descriptive aliases for . - - These do not appear as members of the enumeration - as duplicated underlying values result in issues when presenting - enum values with . - - - - The least significant level of event. - - - - - The most significant level of event. - - - - - A log event. - - - - - Construct a new . - - The time at which the event occurred. - The level of the event. - An exception associated with the event, or null. - The message template describing the event. - Properties associated with the event, including those presented in . - When is null - When is null - - - - Construct a new . - - The time at which the event occurred. - The level of the event. - An exception associated with the event, or null. - The message template describing the event. - Properties associated with the event, including those presented in . - When is null - When is null - - - - The time at which the event occurred. - - - - - The level of the event. - - - - - The message template describing the event. - - - - - Render the message template to the specified output, given the properties associated - with the event. - - The output. - Supplies culture-specific formatting information, or null. - - - - Render the message template given the properties associated - with the event, and return the result. - - Supplies culture-specific formatting information, or null. - - - - Properties associated with the event, including those presented in . - - - - - An exception associated with the event, or null. - - - - - Add a property to the event if not already present, otherwise, update its value. - - The property to add or update. - When is null - - - - Add a property to the event if not already present, otherwise, update its value. - - The property to add or update. - When is default - - - - Add a property to the event if not already present. - - The property to add. - When is null - - - - Add a property to the event if not already present. - - The property to add. - When is default - - - - Remove a property from the event, if present. Otherwise no action - is performed. - - The name of the property to remove. - - - - Specifies the meaning and relative importance of a log event. - - - - - Anything and everything you might want to know about - a running block of code. - - - - - Internal system events that aren't necessarily - observable from the outside. - - - - - The lifeblood of operational intelligence - things - happen. - - - - - Service is degraded or endangered. - - - - - Functionality is unavailable, invariants are broken - or data is lost. - - - - - If you have a pager, it goes off when one of these - occurs. - - - - - A property associated with a . - - - - - Construct a with the specified name and value. - - The name of the property. - The value of the property. - When is null - When is empty or only contains whitespace - When is null - - - - Construct a from an existing instance. - - The existing property. - When is default - - - - The name of the property. - - - - - The value of the property. - - - - - Test to determine if it is a valid property name. - - The name to check. - True if the name is valid; otherwise, false. - - - When is null - When is empty or only contains whitespace - - - - The value associated with a . Divided into scalar, - sequence and structure values to direct serialization into various formats. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - Formats the value of the current instance using the specified format. - - - The value of the current instance in the specified format. - - The format to use.-or- A null reference (Nothing in Visual Basic) to use - the default format defined for the type of the implementation. - The provider to use to format the value.-or- A null reference - (Nothing in Visual Basic) to obtain the numeric format information from the current locale - setting of the operating system. 2 - - - - Represents a message template passed to a log method. The template - can subsequently render the template in textual form given the list - of properties. - - - - - Represents the empty message template. - - - - - Construct a message template using manually-defined text and property tokens. - - The text and property tokens defining the template. - - - - Construct a message template using manually-defined text and property tokens. - - The full text of the template; used by Serilog internally to avoid unneeded - string concatenation. - The text and property tokens defining the template. - When is null - When is null - - - - Similar to , but faster. - - - - - The raw text describing the template. - - - - - Render the template as a string. - - The string representation of the template. - - - - The tokens parsed from the template. - - - - - Convert the message template into a textual message, given the - properties matching the tokens in the message template. - - Properties matching template tokens. - Supplies culture-specific formatting information, or null. - The message created from the template and properties. If the - properties are mismatched with the template, the template will be - returned with incomplete substitution. - When is null - - - - Convert the message template into a textual message, given the - properties matching the tokens in the message template. - - Properties matching template tokens. - The message created from the template and properties. If the - properties are mismatched with the template, the template will be - returned with incomplete substitution. - Supplies culture-specific formatting information, or null. - When is null - When is null - - - - A property value corresponding to a simple, scalar type. - - - - - Construct a with the specified - value. - - The value, which may be null. - - - - The value, which may be null. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - When is null - - - When is null - - - - Determine if this instance is equal to . - - The instance to compare with. - True if the instances are equal; otherwise, false. - - - - Get a hash code representing the value. - - The instance's hash code. - - - - A value represented as an ordered sequence of values. - - - - - Create a with the provided . - - The elements of the sequence. - When is null - - - - The elements of the sequence. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - When is null - - - - A value represented as a collection of name-value properties. - - - - - Construct a with the provided properties. - - Optionally, a piece of metadata describing the "type" of the - structure. Can be null. - The properties of the structure. - When is null - - - - A piece of metadata describing the "type" of the - structure, or null. - - - - - The properties of the structure. - - Not presented as a dictionary because dictionary construction is - relatively expensive; it is cheaper to build a dictionary over properties only - when the structure is of interest. - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - When is null - - - - Predicates applied to log events that can be used - - - - - Matches events from the specified source type. - - The source type. - A predicate for matching events. - - - - Matches events from the specified source type or namespace and - nested types or namespaces. - - A dotted source type or namespace identifier. - A function that matches log events emitted by the source. - When is null - - - - Matches events with the specified property attached, - regardless of its value. - - The name of the property to match. - A predicate for matching events. - When is null - - - - Matches events with the specified property value. - - The name of the property to match. - The property value to match; must be a scalar type. - Null is allowed. - A predicate for matching events. - When is null - - - - Matches events with the specified property value. - - The name of the property to match. - A predicate for testing - The type of scalar values to match. - A predicate for matching events. - When is null - When is null - - - - Implements the {Level} element. - can now have a fixed width applied to it, as well as casing rules. - Width is set through formats like "u3" (uppercase three chars), - "w1" (one lowercase char), or "t4" (title case four chars). - - - - - A that supports the Serilog - message template format. Formatting log events for display - has a different set of requirements and expectations from - rendering the data within them. To meet this, the formatter - overrides some behavior: First, strings are always output - as literals (not quoted) unless some other format is applied - to them. Second, tokens without matching properties are skipped - rather than being written as raw text. - - - - - Construct a . - - A message template describing the - output messages. - Supplies culture-specific formatting information, or null. - When is null - - - - Format the log event into the output. - - The event to format. - The output. - When is null - When is null - - - - This method will apply only upper or lower case formatting, not fixed width - - - - - Describes the properties available in standard message template-based - output format strings. - - - - - The message rendered from the log event. - - - - - The timestamp of the log event. - - - - - The level of the log event. - - - - - A new line. - - - - - The exception associated with the log event. - - - - - The properties of the log event. - - - - - Create properties from the provided log event. - - The log event. - A dictionary with properties representing the log event. - - - - Create properties from the provided log event. - - The log event. - The output template. - A dictionary with properties representing the log event. - - - - Formats log events in a textual representation. - - - - - Format the log event into the output. - - The event to format. - The output. - - - - Formats log events in a simple JSON structure. Instances of this class - are safe for concurrent access by multiple threads. - - - - - Construct a . - - A string that will be written after each log event is formatted. - If null, will be used. - If true, the message will be rendered and written to the output as a - property named RenderedMessage. - Supplies culture-specific formatting information, or null. - - - - Construct a . - - If true, the properties of the event will be written to - the output without enclosing braces. Otherwise, if false, each event will be written as a well-formed - JSON object. - A string that will be written after each log event is formatted. - If null, will be used. Ignored if - is true. - If true, the message will be rendered and written to the output as a - property named RenderedMessage. - Supplies culture-specific formatting information, or null. - - - - Format the log event into the output. - - The event to format. - The output. - When is null - When is null - - - - Adds a writer function for a given type. - - The type of values, which handles. - The function, which writes the values. - When is null - When is null - - - - Writes out individual renderings of attached properties - - - - - Writes out the values of individual renderings of attached properties - - - - - Writes out the attached properties - - - - - Writes out the attached properties values - - - - - Writes out the attached exception - - - - - (Optionally) writes out the rendered message - - - - - Writes out the message template for the logevent. - - - - - Writes out the log level - - - - - Writes out the log timestamp - - - - - Writes out a structure property - - - - - Writes out a sequence property - - - - - Writes out a dictionary - - - - - Writes out a json property with the specified value on output writer - - - - - Allows a subclass to write out objects that have no configured literal writer. - - The value to be written as a json construct - The writer to write on - - - - Perform simple JSON string escaping on . - - A raw string. - A JSON-escaped version of . - - - - Converts Serilog's structured property value format into JSON. - - - - - Construct a . - - When serializing structured (object) values, - the property name to use for the Serilog field - in the resulting JSON. If null, no type tag field will be written. The default is - "_typeTag". - - - - Format as JSON to . - - The value to format - The output - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - When is null - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Visit a value. - - Operation state. - The value to visit. - The result of visiting . - - - - Write a literal as a single JSON value, e.g. as a number or string. Override to - support more value types. Don't write arrays/structures through this method - the - active destructuring policies have already indicated the value should be scalar at - this point. - - The value to write. - The output - - - - Write a valid JSON string literal, escaping as necessary. - - The string value to write. - The output. - - - - Formats log events as a raw dump of the message template and properties. - - - - - Format the log event into the output. - - The event to format. - The output. - - - - The core Serilog logging API, used for writing log events. - - - var log = new LoggerConfiguration() - .WriteTo.Console() - .CreateLogger(); - - var thing = "World"; - log.Information("Hello, {Thing}!", thing); - - - The methods on (and its static sibling ) are guaranteed - never to throw exceptions. Methods on all other types may. - - - - - Create a logger that enriches log events via the provided enrichers. - - Enricher that applies in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events via the provided enrichers. - - Enrichers that apply in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events with the specified property. - - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Write an event to the log. - - The event to write. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - - - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Determine if events at the specified level will be passed through - to the log sinks. - - Level to check. - True if the level is enabled; otherwise, false. - - - - Write a log event with the level. - - Message template describing the event. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Uses configured scalar conversion and destructuring rules to bind a set of properties to a - message template. Returns false if the template or values are invalid (ILogger - methods never throw exceptions). - - Message template describing an event. - Objects positionally formatted into the message template. - The internal representation of the template, which may be used to - render the as text. - Captured properties from the template and . - - MessageTemplate template; - IEnumerable<LogEventProperty> properties>; - if (Log.BindMessageTemplate("Hello, {Name}!", new[] { "World" }, out template, out properties) - { - var propsByName = properties.ToDictionary(p => p.Name, p => p.Value); - Console.WriteLine(template.Render(propsByName, null)); - // -> "Hello, World!" - } - - - - - Uses configured scalar conversion and destructuring rules to bind a property value to its captured - representation. - - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - The resulting property. - True if the property could be bound, otherwise false (ILogger - methods never throw exceptions). - - - - An optional static entry point for logging that can be easily referenced - by different parts of an application. To configure the - set the Logger static property to a logger instance. - - - Log.Logger = new LoggerConfiguration() - .WithConsoleSink() - .CreateLogger(); - - var thing = "World"; - Log.Logger.Information("Hello, {Thing}!", thing); - - - The methods on (and its dynamic sibling ) are guaranteed - never to throw exceptions. Methods on all other types may. - - - - - The globally-shared logger. - - When is null - - - - Resets to the default and disposes the original if possible - - - - - Create a logger that enriches log events via the provided enrichers. - - Enricher that applies in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events via the provided enrichers. - - Enrichers that apply in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events with the specified property. - - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Write an event to the log. - - The event to write. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Determine if events at the specified level will be passed through - to the log sinks. - - Level to check. - True if the level is enabled; otherwise, false. - - - - Write a log event with the level. - - Message template describing the event. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Uses configured scalar conversion and destructuring rules to bind a set of properties to a - message template. Returns false if the template or values are invalid (ILogger - methods never throw exceptions). - - Message template describing an event. - Objects positionally formatted into the message template. - The internal representation of the template, which may be used to - render the as text. - Captured properties from the template and . - - MessageTemplate template; - IEnumerable<LogEventProperty> properties>; - if (Log.BindMessageTemplate("Hello, {Name}!", new[] { "World" }, out template, out properties) - { - var propsByName = properties.ToDictionary(p => p.Name, p => p.Value); - Console.WriteLine(template.Render(propsByName, null)); - // -> "Hello, World!" - } - - - - - Uses configured scalar conversion and destructuring rules to bind a property value to its captured - representation. - - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - The resulting property. - True if the property could be bound, otherwise false (ILogger - methods never throw exceptions). - - - - Configuration object for creating instances. - - - - - Construct a . - - - - - Configures the sinks that log events will be emitted to. - - - - - Configures sinks for auditing, instead of regular (safe) logging. When auditing is used, - exceptions from sinks and any intermediate filters propagate back to the caller. Most callers - should use instead. - - - Not all sinks are compatible with transactional auditing requirements (many will use asynchronous - batching to improve write throughput and latency). Sinks need to opt-in to auditing support by - extending , though the generic - method allows any sink class to be adapted for auditing. - - - - - Configures the minimum level at which events will be passed to sinks. If - not specified, only events at the - level and above will be passed through. - - Configuration object allowing method chaining. - - - - Configures enrichment of s. Enrichers can add, remove and - modify the properties associated with events. - - - - - Configures global filtering of s. - - - - - Configures destructuring of message template parameters. - - - - - Apply external settings to the logger configuration. - - - - - Create a logger using the configured sinks, enrichers and minimum level. - - The logger. - To free resources held by sinks ahead of program shutdown, - the returned logger may be cast to and - disposed. - When the logger is already created - - - - Extends with additional methods. - - - - - Create a logger that enriches log events when the specified level is enabled. - - The type of the property value. - The logger. - The log event level used to determine if log is enriched with property. - The name of the property. Must be non-empty. - The property value. - If true, the value will be serialized as a structured - object if possible; if false, the object will be recorded as a scalar or simple array. - A logger that will enrich log events as specified. - When is null - - - - A structure representing the alignment settings to apply when rendering a property. - - - - - Initializes a new instance of . - - The text alignment direction. - The width of the text, in characters. - - - - The text alignment direction. - - - - - The width of the text. - - - - - Defines the direction of the alignment. - - - - - Text will be left-aligned. - - - - - Text will be right-aligned. - - - - - Instructs the logger on how to store information about provided - parameters. - - - - - Convert known types and objects to scalars, arrays to sequences. - - - - - Convert all types to scalar strings. Prefix name with '$'. - - - - - Convert known types to scalars, destructure objects and collections - into sequences and structures. Prefix name with '@'. - - - - - Parses message template strings into sequences of text or property - tokens. - - - - - Parse the supplied message template. - - The message template to parse. - A sequence of text or property tokens. Where the template - is not syntactically valid, text tokens will be returned. The parser - will make a best effort to extract valid property tokens even in the - presence of parsing issues. - When is null - - - - An element parsed from a message template string. - - - - - Construct a . - - The token's start index in the template. - - - - The token's start index in the template. - - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - - - - A message template token representing a log event property. - - - - - Construct a . - - The name of the property. - The token as it appears in the message template. - The format applied to the property, if any. - The destructuring strategy applied to the property, if any. - - - - - Construct a . - - The name of the property. - The token as it appears in the message template. - The format applied to the property, if any. - The alignment applied to the property, if any. - The destructuring strategy applied to the property, if any. - The token's start index in the template. - When is null - When is null - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - When is null - When is null - - - - The property name. - - - - - Destructuring strategy applied to the property. - - - - - Format applied to the property. - - - - - Alignment applied to the property. - - - - - True if the property name is a positional index; otherwise, false. - - - - - Try to get the integer value represented by the property name. - - The integer value, if present. - True if the property is positional, otherwise false. - - - - Determines whether the specified is equal to the current . - - - true if the specified object is equal to the current object; otherwise, false. - - The object to compare with the current object. 2 - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - 2 - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - A message template token representing literal text. - - - - - Construct a . - - The text of the token. - The token's start index in the template. - When is null - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - When is null - - - - Determines whether the specified is equal to the current . - - - true if the specified object is equal to the current object; otherwise, false. - - The object to compare with the current object. 2 - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - 2 - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - The text of the token. - - - - - Apply upper or lower casing to when is provided. - Returns when no or invalid format provided - - The provided with formatting applied - - - - Writes the provided value to the output, applying direction-based padding when is provided. - - - - - Contains "fake extension" methods for the Serilog configuration API. - By default the settings knows how to find extension methods, but some configuration - are actually "regular" method calls and would not be found otherwise. - - This static class contains internal methods that can be used instead. - - See also - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml.meta deleted file mode 100644 index 638a0256..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/Serilog.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b170dbe05a7468e4e9dda888020fb978 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta deleted file mode 100644 index 5ba29f7b..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: a7cd60ea1c29afe4c95afe8164f6ed20 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 1 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml deleted file mode 100644 index 3769ca7f..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml +++ /dev/null @@ -1,1563 +0,0 @@ - - - - System.IdentityModel.Tokens.Jwt - - - - - Defines the inbound and outbound mapping for claim claim types from jwt to .net claim - - - - - Initializes static members of the class. - - - - - Gets the InboundClaimTypeMap used by JwtSecurityTokenHandler when producing claims from jwt. - - - - - Gets the OutboundClaimTypeMap is used by JwtSecurityTokenHandler to shorten claim types when creating a jwt. - - - - - Constants for Json Web tokens. - - - - - A URI that represents the JSON XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON array XML data type. - - When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'. - - - - A URI that represents the JSON null data type - - When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull - - - - Delegate that can be set on to control serialization of objects into JSON. - - Object to serialize - The serialized object. - - - - Delegate that can be set on to control deserialization JSON into objects. - - JSON to deserialize. - Type expected. - The deserialized object. - - - - Dictionary extensions for serializations - - - - - Gets or sets a to use when serializing objects to JSON. - - If 'value' is null. - - - - Gets or sets a to use when deserializing objects from JSON. - - If 'value' is null. - - - - Serializes an object to JSON. - - The object to serialize - The object as JSON. - - - - Deserialzes JSON into an instance of type T. - - The object type. - The JSON to deserialze. - A new instance of type T. - - - - Deserialzes JSON into an instance of . - - The JSON to deserialze. - A new instance . - - - - Deserialzes JSON into an instance of . - - The JSON to deserialze. - A new instance . - - - - Constants for Json Web tokens. - - - - - Short header type. - - - - - Long header type. - - - - - Short token type. - - - - - Long token type. - - - - - JWS - Token format: 'header.payload.signature'. Signature is optional, but '.' is required. - - - - - JWE - Token format: 'protectedheader.encryptedkey.iv.cyphertext.authenticationtag'. - - - - - The number of parts in a JWE token. - - - - - The number of parts in a JWS token. - - - - - The maximum number of parts in a JWT. - - - - - JWE header alg indicating a shared symmetric key is directly used as CEK. - - - - - Initializes a new instance of which contains JSON objects representing the cryptographic operations applied to the JWT and optionally any additional properties of the JWT. - The member names within the JWT Header are referred to as Header Parameter Names. - These names MUST be unique and the values must be (s). The corresponding values are referred to as Header Parameter Values. - - - - - Initializes a new instance of the class. Default string comparer . - - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, SigningCredentials.Algorithm } } - - used creating a JWS Compact JSON. - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, EncryptingCredentials.Alg }, { enc, EncryptingCredentials.Enc } } - - used creating a JWE Compact JSON. - If 'encryptingCredentials' is null. - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, SigningCredentials.Algorithm } } - - used when creating a JWS Compact JSON. - provides a mapping for the 'alg' value so that values are within the JWT namespace. - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, SigningCredentials.Algorithm } } - - used when creating a JWS Compact JSON. - provides a mapping for the 'alg' value so that values are within the JWT namespace. - will be added as the value for the 'typ' claim in the header. If it is null or empty will be used as token type - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, SigningCredentials.Algorithm } } - - used when creating a JWS Compact JSON. - provides a mapping for the 'alg' value so that values are within the JWT namespace. - If 'encryptingCredentials' is null. - - - - Initializes a new instance of . - With the Header Parameters: - { { typ, JWT }, { alg, SigningCredentials.Algorithm } } - - used when creating a JWS Compact JSON. - provides a mapping for the 'alg' value so that values are within the JWT namespace. - provides the token type - If 'encryptingCredentials' is null. - - - - Gets the signature algorithm that was used to create the signature. - - If the signature algorithm is not found, null is returned. - - - - Gets the content mime type (Cty) of the token. - - If the content mime type is not found, null is returned. - - - - Gets the encryption algorithm (Enc) of the token. - - If the content mime type is not found, null is returned. - - - - Gets the passed in the constructor. - - This value may be null. - - - - Gets the iv of symmetric key wrap. - - - - - Gets the key identifier for the security key used to sign the token - - - - - Gets the passed in the constructor. - - This value may be null. - - - - Gets the mime type (Typ) of the token. - - If the mime type is not found, null is returned. - - - - Gets the thumbprint of the certificate used to sign the token - - - - - Gets the certificate used to sign the token - - If the 'x5c' claim is not found, null is returned. - - - - Gets the 'value' of the 'zip' claim { zip, 'value' }. - - If the 'zip' claim is not found, null is returned. - - - - Deserializes Base64UrlEncoded JSON into a instance. - - Base64url encoded JSON to deserialize. - An instance of . - Use to customize JSON serialization. - - - - Encodes this instance as Base64UrlEncoded JSON. - - Base64UrlEncoded JSON. - Use to customize JSON serialization. - - - - Deserialzes JSON into a instance. - - The JSON to deserialize. - An instance of . - Use to customize JSON serialization. - - - - Gets a standard claim from the header. - A standard claim is either a string or a value of another type serialized in JSON format. - - The key of the claim. - The standard claim string; or null if not found. - - - - Serializes this instance to JSON. - - This instance as JSON. - Use to customize JSON serialization. - - - - List of header parameter names see: http://tools.ietf.org/html/rfc7519#section-5. - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.10 - also:https://tools.ietf.org/html/rfc7519#section-5.2 - - - - - see:https://tools.ietf.org/html/rfc7516#section-4.1.2 - - - - - see:https://tools.ietf.org/html/rfc7518#section-4.7.1.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.2 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.3 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.4 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.9 - also:https://tools.ietf.org/html/rfc7519#section-5.1 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.6 - - - - - see:https://tools.ietf.org/html/rfc7515#page-12 - - - - - see:https://tools.ietf.org/html/rfc7515#section-4.1.5 - - - - - see:https://tools.ietf.org/html/rfc7516#section-4.1.3 - - - - - Initializes a new instance of which contains JSON objects representing the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }. - - - - - Initializes a new instance of the class with no claims. Default string comparer . - Creates a empty - - - - - Initializes a new instance of the class with . Default string comparer . - The claims to add. - - - - - Initializes a new instance of the class with claims added for each parameter specified. Default string comparer . - - If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' if present. - If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' if present. - If this value is not null then for each a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' if present. - If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' if present. - - - - Initializes a new instance of the class with claims added for each parameter specified. Default string comparer . - - If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' if present. - If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' if present. - If this value is not null then for each a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' if present. - If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' if present. - If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' if present. - Comparison is set to - The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over (s) in 'claims'. The values will be overridden. - If 'expires' <= 'notbefore'. - - - - Initializes a new instance of the class with claims added for each parameter specified. Default string comparer . - - If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present. - If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' or 'claimCollection' if present. - If this value is not null then for each a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - If both and are not null then the values in claims will be combined with the values in claimsCollection. The values found in claimCollection take precedence over those found in claims, so any duplicate - values will be overridden. - If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present. - If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present. - If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present. - Comparison is set to - The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over (s) in 'claims' and 'claimcollection'. The values will be overridden. - If 'expires' <= 'notbefore'. - - - - Adds Nbf, Exp, Iat, Iss and Aud claims to payload - - If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in instance. - If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in instance. - If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in instance. - If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in instance. - If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in instance. - - - - Gets the 'value' of the 'actor' claim { actort, 'value' }. - - If the 'actor' claim is not found, null is returned. - - - - Gets the 'value' of the 'acr' claim { acr, 'value' }. - - If the 'acr' claim is not found, null is returned. - - - - Gets the 'value' of the 'amr' claim { amr, 'value' } as list of strings. - - If the 'amr' claim is not found, an empty enumerable is returned. - - - - Gets the 'value' of the 'auth_time' claim { auth_time, 'value' }. - - If the 'auth_time' claim is not found OR could not be converted to , null is returned. - - - - Gets the 'value' of the 'audience' claim { aud, 'value' } as a list of strings. - - If the 'audience' claim is not found, an empty enumerable is returned. - - - - Gets the 'value' of the 'azp' claim { azp, 'value' }. - - If the 'azp' claim is not found, null is returned. - - - - Gets 'value' of the 'c_hash' claim { c_hash, 'value' }. - - If the 'c_hash' claim is not found, null is returned. - - - - Gets the 'value' of the 'expiration' claim { exp, 'value' }. - - If the 'expiration' claim is not found OR could not be converted to , null is returned. - - - - Gets the 'value' of the 'JWT ID' claim { jti, 'value' }. - - If the 'JWT ID' claim is not found, null is returned. - - - - Gets the 'value' of the 'Issued At' claim { iat, 'value' }. - - If the 'Issued At' claim is not found OR cannot be converted to null is returned. - - - - Gets the 'value' of the 'issuer' claim { iss, 'value' }. - - If the 'issuer' claim is not found, null is returned. - - - - Gets the 'value' of the 'expiration' claim { nbf, 'value' }. - - If the 'notbefore' claim is not found OR could not be converted to , null is returned. - - - - Gets the 'value' of the 'nonce' claim { nonce, 'value' }. - - If the 'nonce' claim is not found, null is returned. - - - - Gets the 'value' of the 'subject' claim { sub, 'value' }. - - If the 'subject' claim is not found, null is returned. - - - - Gets the 'value' of the 'notbefore' claim { nbf, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'notbefore' claim is not found, then is returned. Time is returned as UTC. - - - - Gets the 'value' of the 'expiration' claim { exp, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'expiration' claim is not found, then is returned. - - - - Gets the 'value' of the 'issued at' claim { iat, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'issued at' claim is not found, then is returned. - - - - Gets a for each JSON { name, value }. - - Each (s) returned will have the translated according to the mapping found in . Adding and removing to will affect the value of the . - and will be set to the value of ( if null). - - - - Adds a JSON object representing the to the - - { 'Claim.Type', 'Claim.Value' } is added. If a JSON object is found with the name == then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - See For details on how is applied. - 'claim' is null. - - - - Adds a number of to the as JSON { name, value } pairs. - - For each a JSON pair { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - - Any in the that is null, will be ignored. - is null. - - - - Adds claims from dictionary. - - A dictionary of claims. - If a key is already present in target dictionary, its value is overridden by the value of the key in claimsCollection. - - - - Gets the DateTime using the number of seconds from 1970-01-01T0:0:0Z (UTC) - - Claim in the payload that should map to an integer. - If the claim is not found, the function returns: DateTime.MinValue - - If an overflow exception is thrown by the runtime. - The DateTime representation of a claim. - - - - Serializes this instance to JSON. - - This instance as JSON. - Use to customize JSON serialization. - - - - Encodes this instance as Base64UrlEncoded JSON. - - Base64UrlEncoded JSON. - Use to customize JSON serialization. - - - - Deserializes Base64UrlEncoded JSON into a instance. - - base64url encoded JSON to deserialize. - An instance of . - Use to customize JSON serialization. - - - - Deserialzes JSON into a instance. - - The JSON to deserialize. - An instance of . - Use to customize JSON serialization. - - - - List of registered claims from different sources - http://tools.ietf.org/html/rfc7519#section-4 - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#IDToken - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#HybridIDToken - - - - - http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims - - - - - - - - - https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - - - - - http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout - - - - - http://tools.ietf.org/html/rfc7519#section-4 - - - - - http://tools.ietf.org/html/rfc7519#section-5 - - - - - - - - - - - - - A designed for representing a JSON Web Token (JWT). - - - - - Initializes a new instance of from a string in JWS Compact serialized format. - - A JSON Web Token that has been serialized in JWS Compact serialized format. - 'jwtEncodedString' is null. - 'jwtEncodedString' contains only whitespace. - 'jwtEncodedString' is not in JWS Compact serialized format. - - The contents of this have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using - - - - - Initializes a new instance of the class where the contains the crypto algorithms applied to the encoded and . The jwtEncodedString is the result of those operations. - - Contains JSON objects representing the cryptographic operations applied to the JWT and optionally any additional properties of the JWT - Contains JSON objects representing the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value } - base64urlencoded JwtHeader - base64urlencoded JwtPayload - base64urlencoded JwtSignature - 'header' is null. - 'payload' is null. - 'rawSignature' is null. - 'rawHeader' or 'rawPayload' is null or whitespace. - - - - Initializes an instance of where the contains the crypto algorithms applied to the innerToken . - - Defines cryptographic operations applied to the 'innerToken'. - - base64urlencoded key - base64urlencoded JwtHeader - base64urlencoded initialization vector. - base64urlencoded encrypted innerToken - base64urlencoded authentication tag. - 'header' is null. - 'innerToken' is null. - 'rawHeader' is null. - 'rawEncryptedKey' is null. - 'rawInitialVector' is null or empty. - 'rawCiphertext' is null or empty. - 'rawAuthenticationTag' is null or empty. - - - - Initializes a new instance of the class where the contains the crypto algorithms applied to the encoded and . The jwtEncodedString is the result of those operations. - - Contains JSON objects representing the cryptographic operations applied to the JWT and optionally any additional properties of the JWT - Contains JSON objects representing the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value } - 'header' is null. - 'payload' is null. - - - - Initializes a new instance of the class specifying optional parameters. - - If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' if present. - If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' if present. - If this value is not null then for each a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values. - If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' if present. - If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' if present. - The that will be used to sign the . See for details pertaining to the Header Parameter(s). - If 'expires' <= 'notbefore'. - - - - Gets the 'value' of the 'actor' claim { actort, 'value' }. - - If the 'actor' claim is not found, null is returned. - - - - Gets the list of 'audience' claim { aud, 'value' }. - - If the 'audience' claim is not found, enumeration will be empty. - - - - Gets the (s) for this token. - If this is a JWE token, this property only returns the encrypted claims; - the unencrypted claims should be read from the header seperately. - - (s) returned will NOT have the translated according to - - - - Gets the Base64UrlEncoded associated with this instance. - - - - - Gets the Base64UrlEncoded associated with this instance. - - - - - Gets the associated with this instance if the token is signed. - - - - - Gets the 'value' of the 'JWT ID' claim { jti, ''value' }. - - If the 'JWT ID' claim is not found, an empty string is returned. - - - - Gets the 'value' of the 'issuer' claim { iss, 'value' }. - - If the 'issuer' claim is not found, an empty string is returned. - - - - Gets the associated with this instance. - Note that if this JWT is nested ( != null, this property represents the payload of the most inner token. - This property can be null if the content type of the most inner token is unrecognized, in that case - the content of the token is the string returned by PlainText property. - - - - - Gets the associated with this instance. - - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the original raw data of this instance when it was created. - - The original JSON Compact serialized format passed to one of the two constructors - or - - - - Gets the s for this instance. - - - - - Gets the signature algorithm associated with this instance. - - If there is a associated with this instance, a value will be returned. Null otherwise. - - - - Gets the to use when writing this token. - - - - - Gets the to use when writing this token. - - - - - Gets or sets the that signed this instance. - - .ValidateSignature(...) sets this value when a is used to successfully validate a signature. - - - - Gets the "value" of the 'subject' claim { sub, 'value' }. - - If the 'subject' claim is not found, null is returned. - - - - Gets the 'value' of the 'notbefore' claim { nbf, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'notbefore' claim is not found, then is returned. - - - - Gets the 'value' of the 'expiration' claim { exp, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'expiration' claim is not found, then is returned. - - - - Gets the 'value' of the 'issued at' claim { iat, 'value' } converted to a assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). - - If the 'issued at' claim is not found, then is returned. - - - - Serializes the and - - A string containing the header and payload in JSON format. - - - - Decodes the string into the header, payload and signature. - - the tokenized string. - the original token. - - - - Decodes the payload and signature from the JWS parts. - - Parts of the JWS including the header. - Assumes Header has already been set. - - - - Decodes the payload and signature from the JWE parts. - - Parts of the JWE including the header. - Assumes Header has already been set. - - - - A designed for creating and validating Json Web Tokens. See: http://tools.ietf.org/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515 - - - - - Default claim type mapping for inbound claims. - - - - - Default value for the flag that determines whether or not the InboundClaimTypeMap is used. - - - - - Default claim type mapping for outbound claims. - - - - - Default claim type filter list. - - - - - Default JwtHeader algorithm mapping - - - - - Static initializer for a new object. Static initializers run before the first instance of the type is created. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the property which is used when determining whether or not to map claim types that are extracted when validating a . - If this is set to true, the is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs. - The default value is true. - - - - - Gets or sets the which is used when setting the for claims in the extracted when validating a . - The is set to the JSON claim 'name' after translating using this mapping. - The default value is ClaimTypeMapping.InboundClaimTypeMap. - - 'value' is null. - - - - Gets or sets the which is used when creating a from (s). - The JSON claim 'name' value is set to after translating using this mapping. - The default value is ClaimTypeMapping.OutboundClaimTypeMap - - This mapping is applied only when using or . Adding values directly will not result in translation. - 'value' is null. - - - - Gets the outbound algorithm map that is passed to the constructor. - - - - Gets or sets the used to filter claims when populating a claims form a . - When a is validated, claims with types found in this will not be added to the . - The default value is ClaimTypeMapping.InboundClaimFilter. - - 'value' is null. - - - - Gets or sets the property name of the will contain the original JSON claim 'name' if a mapping occurred when the (s) were created. - See for more information. - - If .IsNullOrWhiteSpace('value') is true. - - - - Gets or sets the property name of the will contain .Net type that was recognized when JwtPayload.Claims serialized the value to JSON. - See for more information. - - If .IsNullOrWhiteSpace('value') is true. - - - - Returns a value that indicates if this handler can validate a . - - 'true', indicating this instance can validate a . - - - - Gets the value that indicates if this instance can write a . - - 'true', indicating this instance can write a . - - - - Gets the type of the . - - The type of - - - - Determines if the string is a well formed Json Web Token (JWT). - see: http://tools.ietf.org/html/rfc7519 - - String that should represent a valid JWT. - Uses matching one of: - JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$" - JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$" - JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$" - - - 'false' if the token is null or whitespace. - 'false' if token.Length is greater than . - 'true' if the token is in JSON compact serialization format. - - - - - Returns a Json Web Token (JWT). - - A that contains details of contents of the token. - A JWS and JWE can be returned. - If is provided, then a JWE will be created. - If is provided then a JWS will be created. - If both are provided then a JWE with an embedded JWS will be created. - - - - - Creates a JWT in 'Compact Serialization Format'. - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - The notbefore time for this token. - The expiration time for this token. - The issue time for this token. - Contains cryptographic material for generating a signature. - If is not null, then a claim { actort, 'value' } will be added to the payload. See for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each in the will map by applying . Modifying could change the outbound JWT. - If is provided, then a JWS will be created. - - A Base64UrlEncoded string in 'Compact Serialization Format'. - - - - Creates a JWT in 'Compact Serialization Format'. - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - Translated into 'epoch time' and assigned to 'nbf'. - Translated into 'epoch time' and assigned to 'exp'. - Translated into 'epoch time' and assigned to 'iat'. - Contains cryptographic material for signing. - Contains cryptographic material for encrypting. - If is not null, then a claim { actort, 'value' } will be added to the payload. for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each in the will map by applying . Modifying could change the outbound JWT. - - A Base64UrlEncoded string in 'Compact Serialization Format'. - If 'expires' <= 'notBefore'. - - - - Creates a JWT in 'Compact Serialization Format'. - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - Translated into 'epoch time' and assigned to 'nbf'. - Translated into 'epoch time' and assigned to 'exp'. - Translated into 'epoch time' and assigned to 'iat'. - Contains cryptographic material for signing. - Contains cryptographic material for encrypting. - A collection of (key,value) pairs representing (s) for this token. - If is not null, then a claim { actort, 'value' } will be added to the payload. for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each in the will map by applying . Modifying could change the outbound JWT. - - A Base64UrlEncoded string in 'Compact Serialization Format'. - If 'expires' <= 'notBefore'. - - - - Creates a Json Web Token (JWT). - - A that contains details of contents of the token. - is used to sign . - - - - Creates a - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - The notbefore time for this token. - The expiration time for this token. - The issue time for this token. - Contains cryptographic material for generating a signature. - Contains cryptographic material for encrypting the token. - If is not null, then a claim { actort, 'value' } will be added to the payload. for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each on the added will have translated according to the mapping found in - . Adding and removing to will affect the name component of the Json claim. - is used to sign . - is used to encrypt or . - - A . - If 'expires' <= 'notBefore'. - - - - Creates a - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - The notbefore time for this token. - The expiration time for this token. - The issue time for this token. - Contains cryptographic material for generating a signature. - Contains cryptographic material for encrypting the token. - A collection of (key,value) pairs representing (s) for this token. - If is not null, then a claim { actort, 'value' } will be added to the payload. for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each on the added will have translated according to the mapping found in - . Adding and removing to will affect the name component of the Json claim. - is used to sign . - is used to encrypt or . - - A . - If 'expires' <= 'notBefore'. - - - - Creates a - - The issuer of the token. - The audience for this token. - The source of the (s) for this token. - The notbefore time for this token. - The expiration time for this token. - The issue time for this token. - Contains cryptographic material for generating a signature. - If is not null, then a claim { actort, 'value' } will be added to the payload. for details on how the value is created. - See for details on how the HeaderParameters are added to the header. - See for details on how the values are added to the payload. - Each on the added will have translated according to the mapping found in - . Adding and removing to will affect the name component of the Json claim. - is used to sign . - - A . - If 'expires' <= 'notBefore'. - - - - Creates a Json Web Token (JWT). - - A that contains details of contents of the token. - is used to sign . - - - - Converts a string into an instance of . - - A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format. - A - 'token' is null or empty. - 'token.Length' is greater than . - - If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized. - This method is unable to decrypt the payload. Use to obtain the payload. - - - - Converts a string into an instance of . - - A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format. - A - 'token' is null or empty. - 'token.Length' is greater than . - - If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized. - This method is unable to decrypt the payload. Use to obtain the payload. - - - - Deserializes token with the provided . - - . - The current . - The - This method is not current supported. - - - - Reads and validates a 'JSON Web Token' (JWT) encoded as a JWS or JWE in Compact Serialized Format. - - the JWT encoded as JWE or JWS - Contains validation parameters for the . - The that was validated. - is null or whitespace. - is null. - .Length is greater than . - does not have 3 or 5 parts. - returns false. - was a JWE was not able to be decrypted. - 'kid' header claim is not null AND decryption fails. - 'enc' header claim is null or empty. - 'exp' claim is < DateTime.UtcNow. - is null or whitespace and is null. Audience is not validated if is set to false. - 'aud' claim did not match either or one of . - 'nbf' claim is > 'exp' claim. - .signature is not properly formatted. - 'exp' claim is missing and is true. - is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time. - 'nbf' claim is > DateTime.UtcNow. - could not be added to the . - is found in the cache. - A from the JWT. Does not include claims found in the JWT header. - - Many of the exceptions listed above are not thrown directly from this method. See to examine the call graph. - - - - - Validates the JSON payload of a . - - The token to validate. - Contains validation parameters for the . - A from the jwt. Does not include the header claims. - - - - Serializes a into a JWT in Compact Serialization Format. - - to serialize. - - The JWT will be serialized as a JWE or JWS. - will be used to create the JWT. If there is an inner token, the inner token's payload will be used. - If either or .SigningCredentials are set, the JWT will be signed. - If is set, a JWE will be created using the JWT above as the plaintext. - - 'token' is null. - 'token' is not a not . - both and are set. - both and .EncryptingCredentials are set. - if is set and is not set. - A JWE or JWS in 'Compact Serialization Format'. - - - - Obtains a and validates the signature. - - Bytes to validate. - Signature to compare against. - to use. - Crypto algorithm to use. - The being validated. - Priority will be given to over . - 'true' if signature is valid. - - - - Validates that the signature, if found or required, is valid. - - A JWS token. - that contains signing keys. - If 'jwt' is null or whitespace. - If 'validationParameters' is null. - If a signature is not found and is true. - - If the 'token' has a key identifier and none of the (s) provided result in a validated signature. - This can indicate that a key refresh is required. - - - If the 'token' has a key identifier and none of the (s) provided result in a validated signature as well as the token - had validation errors or lifetime or issuer. This is not intended to be a signal to refresh keys. - - If after trying all the (s), none result in a validated signature AND the 'token' does not have a key identifier. - A that has the signature validated if token was signed. - If the 'token' is signed, the signature is validated even if is false. - If the 'token' signature is validated, then the will be set to the key that signed the 'token'.It is the responsibility of to set the - - - - Creates a from a . - - The to use as a source. - The value to set - Contains parameters for validating the token. - A containing the . - - - - Creates the 'value' for the actor claim: { actort, 'value' } - - as actor. - representing the actor. - If is not null: -   If 'type' is 'string', return as string. -   if 'type' is 'BootstrapContext' and 'BootstrapContext.SecurityToken' is 'JwtSecurityToken' -     if 'JwtSecurityToken.RawData' != null, return RawData. -     else return . -   if 'BootstrapContext.Token' != null, return 'Token'. - default: new ( ( actor.Claims ). - - 'actor' is null. - - - - Determines if the audiences found in a are valid. - - The audiences found in the . - The being validated. - required for validation. - See for additional details. - - - - Validates the lifetime of a . - - The value of the 'nbf' claim if it exists in the 'jwtToken'. - The value of the 'exp' claim if it exists in the 'jwtToken'. - The being validated. - required for validation. - for additional details. - - - - Determines if the issuer found in a is valid. - - The issuer to validate - The that is being validated. - required for validation. - The issuer to use when creating the (s) in the . - for additional details. - - - - Determines if a is already validated. - - The value of the 'exp' claim if it exists in the '. - The that is being validated. - required for validation. - - - - Returns a to use when validating the signature of a token. - - The representation of the token that is being validated. - The that is being validated. - A required for validation. - Returns a to use for signature validation. - If key fails to resolve, then null is returned - - - - Returns a to use when decryption a JWE. - - The the token that is being decrypted. - The that is being decrypted. - A required for validation. - Returns a to use for signature validation. - If key fails to resolve, then null is returned - - - - Decrypts a JWE and returns the clear text - - the JWE that contains the cypher text. - contains crypto material. - the decoded / cleartext contents of the JWE. - if 'jwtToken' is null. - if 'validationParameters' is null. - if 'jwtToken.Header.enc' is null or empty. - if 'jwtToken.Header.kid' is not null AND decryption fails. - if the JWE was not able to be decrypted. - - - - Validates the is an expected value. - - The that signed the . - The to validate. - The current . - If the is a then the X509Certificate2 will be validated using the CertificateValidator. - - - - Serializes to XML a token of the type handled by this instance. - - The XML writer. - A token of type . - - - - Log messages and codes - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml.meta deleted file mode 100644 index 08b427b2..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/System.IdentityModel.Tokens.Jwt.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 5f79a77f834b1c544a53af1c35396fac -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.dll.meta deleted file mode 100644 index 8ff8b0b3..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.dll.meta +++ /dev/null @@ -1,95 +0,0 @@ -fileFormatVersion: 2 -guid: c2211162cbfa3994b90d3cd26eb8f661 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 0 - Exclude Linux64: 0 - Exclude LinuxUniversal: 0 - Exclude OSXUniversal: 1 - Exclude Win: 0 - Exclude Win64: 0 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: AnyCPU - - first: - Standalone: Linux - second: - enabled: 1 - settings: - CPU: x86 - - first: - Standalone: Linux64 - second: - enabled: 1 - settings: - CPU: x86_64 - - first: - Standalone: LinuxUniversal - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Standalone: Win64 - second: - enabled: 1 - settings: - CPU: AnyCPU - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml deleted file mode 100644 index ef8d2920..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml +++ /dev/null @@ -1,4936 +0,0 @@ - - - - YamlDotNet - - - - - The exception that is thrown when an alias references an anchor that does not exist. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Defines constants that relate to the YAML specification. - - - - - Emits YAML streams. - - - - - Initializes a new instance of the class. - - The where the emitter will write. - - - - Initializes a new instance of the class. - - The where the emitter will write. - The preferred indentation. - - - - Initializes a new instance of the class. - - The where the emitter will write. - The preferred indentation. - The preferred text width. - - - - Initializes a new instance of the class. - - The where the emitter will write. - The preferred indentation. - The preferred text width. - If true, write the output in canonical form. - - - - Emit an evt. - - - - - Check if we need to accumulate more events before emitting. - - We accumulate extra - - 1 event for DOCUMENT-START - - 2 events for SEQUENCE-START - - 3 events for MAPPING-START - - - - - Expect STREAM-START. - - - - - Expect DOCUMENT-START or STREAM-END. - - - - - Expect the root node. - - - - - Expect a node. - - - - - Expect ALIAS. - - - - - Expect SCALAR. - - - - - Expect SEQUENCE-START. - - - - - Expect MAPPING-START. - - - - - Expect DOCUMENT-END. - - - - - Expect a flow item node. - - - - - Expect a flow key node. - - - - - Expect a flow value node. - - - - - Expect a block item node. - - - - - Expect a block key node. - - - - - Expect a block value node. - - - - - Check if the document content is an empty scalar. - - - - - Check if the next node can be expressed as a simple key. - - - - - The preferred indentation. - - - - - The preferred text width. - - - - - If true, write the output in canonical form. - - - - - If true, write output without anchor names. - - - - - The maximum allowed length for simple keys. - - - The specifiction mandates 1024 characters, but any desired value may be used. - - - - - Indent sequences. The default is to not indent. - - - - - Represents an alias event. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets the value of the alias. - - - - - Initializes a new instance of the class. - - The value of the alias. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - The value of the alias. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Represents a document end event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets a value indicating whether this instance is implicit. - - - true if this instance is implicit; otherwise, false. - - - - - Initializes a new instance of the class. - - Indicates whether the event is implicit. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - Indicates whether the event is implicit. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Represents a document start event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets the tags. - - The tags. - - - - Gets the version. - - The version. - - - - Gets a value indicating whether this instance is implicit. - - - true if this instance is implicit; otherwise, false. - - - - - Initializes a new instance of the class. - - The version. - The tags. - Indicates whether the event is implicit. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - The version. - The tags. - Indicates whether the event is implicit. - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Callback interface for external event Visitor. - - - - - Represents a mapping end event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Represents a mapping start event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets a value indicating whether this instance is implicit. - - - true if this instance is implicit; otherwise, false. - - - - - Gets a value indicating whether this instance is canonical. - - - - - - Gets the style of the mapping. - - - - - Initializes a new instance of the class. - - The anchor. - The tag. - Indicates whether the event is implicit. - The style of the mapping. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - The anchor. - The tag. - Indicates whether the event is implicit. - The style of the mapping. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Specifies the style of a mapping. - - - - - Let the emitter choose the style. - - - - - The block mapping style. - - - - - The flow mapping style. - - - - - Contains the behavior that is common between node events. - - - - - Gets the anchor. - - - - - - Gets the tag. - - - - - - Gets a value indicating whether this instance is canonical. - - - - - - Initializes a new instance of the class. - - The anchor. - The tag. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Base class for parsing events. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets the position in the input stream where the event starts. - - - - - Gets the position in the input stream where the event ends. - - - - - Accepts the specified visitor. - - Visitor to accept, may not be null - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Represents a scalar event. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets the value. - - The value. - - - - Gets the style of the scalar. - - The style. - - - - Gets a value indicating whether the tag is optional for the plain style. - - - - - Gets a value indicating whether the tag is optional for any non-plain style. - - - - - Gets a value indicating whether this instance is canonical. - - - - - - Initializes a new instance of the class. - - The anchor. - The tag. - The value. - The style. - . - . - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - The anchor. - The tag. - The value. - The style. - . - . - - - - Initializes a new instance of the class. - - The value. - - - - Initializes a new instance of the class. - - The tag. - The value. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Represents a sequence end event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Represents a sequence start event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Gets a value indicating whether this instance is implicit. - - - true if this instance is implicit; otherwise, false. - - - - - Gets a value indicating whether this instance is canonical. - - - - - - Gets the style. - - The style. - - - - Initializes a new instance of the class. - - The anchor. - The tag. - if set to true [is implicit]. - The style. - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Specifies the style of a sequence. - - - - - Let the emitter choose the style. - - - - - The block sequence style. - - - - - The flow sequence style. - - - - - Represents a stream end event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Initializes a new instance of the class. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - Represents a stream start event. - - - - - Gets a value indicating the variation of depth caused by this event. - The value can be either -1, 0 or 1. For start events, it will be 1, - for end events, it will be -1, and for the remaining events, it will be 0. - - - - - Gets the event type, which allows for simpler type comparisons. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the event. - The end position of the event. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Invokes run-time type specific Visit() method of the specified visitor. - - visitor, may not be null. - - - - The exception that is thrown when an alias references an anchor - that has not yet been defined in a context that does not support forward references. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Supports implementations of by providing methods to combine two hash codes. - - - - - Combines two hash codes. - - The first hash code. - The second hash code. - - - - - Represents a YAML stream emitter. - - - - - Emits an event. - - - - - Gets a value indicating whether the end of the input reader has been reached. - - - - - Gets the character at the specified offset. - - - - - Skips the next characters. Those characters must have been - obtained first by calling the method. - - - - - Generic queue on which items may be inserted - - - - - Gets the number of items that are contained by the queue. - - - - - Enqueues the specified item. - - The item to be enqueued. - - - - Dequeues an item. - - Returns the item that been dequeued. - - - - Inserts an item at the specified index. - - The index where to insert the item. - The item to be inserted. - - - - Represents a YAML stream parser. - - - - - Gets the current event. Returns null before the first call to , - and also after returns false. - - - - - Moves to the next event. - - Returns true if there are more events available, otherwise returns false. - - - - Defines the interface for a stand-alone YAML scanner that - converts a sequence of characters into a sequence of YAML tokens. - - - - - Gets the current position inside the input stream. - - The current position. - - - - Gets the current token. - - - - - Moves to the next token and consumes the current token. - - - - - Moves to the next token without consuming the current token. - - - - - Consumes the current token. - - - - - Provides access to a stream and allows to peek at the next characters, - up to the buffer's capacity. - - - This class implements a circular buffer with a fixed capacity. - - - - - Initializes a new instance of the class. - - The input. - The capacity. - - - - Gets a value indicating whether the end of the input reader has been reached. - - - - - Gets the index of the character for the specified offset. - - - - - Gets the character at the specified offset. - - - - - Reads characters until at least characters are in the buffer. - - - Number of characters to cache. - - - - - Skips the next characters. Those characters must have been - obtained first by calling the or methods. - - - - - Represents a location inside a file - - - - - Gets a with empty values. - - - - - Gets / sets the absolute offset in the file - - - - - Gets / sets the number of the line - - - - - Gets / sets the index of the column - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - - - - - - - - - - - - - - - - Exception that is thrown when an infinite recursion is detected. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Simple implementation of that implements merging: http://yaml.org/type/merge.html - - - - - Parses YAML streams. - - - - - Initializes a new instance of the class. - - The input where the YAML stream is to be read. - - - - Initializes a new instance of the class. - - - - - Gets the current event. - - - - - Moves to the next event. - - Returns true if there are more events available, otherwise returns false. - - - - Parse the production: - stream ::= STREAM-START implicit_document? explicit_document* STREAM-END - ************ - - - - - Parse the productions: - implicit_document ::= block_node DOCUMENT-END* - * - explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END* - ************************* - - - - - Parse directives. - - - - - Parse the productions: - explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END* - *********** - - - - - Generate an empty scalar event. - - - - - Parse the productions: - block_node_or_indentless_sequence ::= - ALIAS - ***** - | properties (block_content | indentless_block_sequence)? - ********** * - | block_content | indentless_block_sequence - * - block_node ::= ALIAS - ***** - | properties block_content? - ********** * - | block_content - * - flow_node ::= ALIAS - ***** - | properties flow_content? - ********** * - | flow_content - * - properties ::= TAG ANCHOR? | ANCHOR TAG? - ************************* - block_content ::= block_collection | flow_collection | SCALAR - ****** - flow_content ::= flow_collection | SCALAR - ****** - - - - - Parse the productions: - implicit_document ::= block_node DOCUMENT-END* - ************* - explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END* - ************* - - - - - Parse the productions: - block_sequence ::= BLOCK-SEQUENCE-START (BLOCK-ENTRY block_node?)* BLOCK-END - ******************** *********** * ********* - - - - - Parse the productions: - indentless_sequence ::= (BLOCK-ENTRY block_node?)+ - *********** * - - - - - Parse the productions: - block_mapping ::= BLOCK-MAPPING_START - ******************* - ((KEY block_node_or_indentless_sequence?)? - *** * - (VALUE block_node_or_indentless_sequence?)?)* - - BLOCK-END - ********* - - - - - Parse the productions: - block_mapping ::= BLOCK-MAPPING_START - - ((KEY block_node_or_indentless_sequence?)? - - (VALUE block_node_or_indentless_sequence?)?)* - ***** * - BLOCK-END - - - - - - Parse the productions: - flow_sequence ::= FLOW-SEQUENCE-START - ******************* - (flow_sequence_entry FLOW-ENTRY)* - * ********** - flow_sequence_entry? - * - FLOW-SEQUENCE-END - ***************** - flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - * - - - - - Parse the productions: - flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - *** * - - - - - Parse the productions: - flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - ***** * - - - - - Parse the productions: - flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - * - - - - - Parse the productions: - flow_mapping ::= FLOW-MAPPING-START - ****************** - (flow_mapping_entry FLOW-ENTRY)* - * ********** - flow_mapping_entry? - ****************** - FLOW-MAPPING-END - **************** - flow_mapping_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - * *** * - - - - - Parse the productions: - flow_mapping_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)? - * ***** * - - - - - Extension methods that provide useful abstractions over . - - - - - Ensures that the current event is of the specified type, returns it and moves to the next event. - - Type of the . - Returns the current event. - If the current event is not of the specified type. - - - - Checks whether the current event is of the specified type. - If the event is of the specified type, returns it and moves to the next event. - Otherwise returns null. - - Type of the . - Returns true if the current event is of type T; otherwise returns null. - - - - Enforces that the current event is of the specified type. - - Type of the . - Returns the current event. - If the current event is not of the specified type. - - - - Checks whether the current event is of the specified type. - - Type of the event. - Returns true if the current event is of type . Otherwise returns false. - - - - Skips the current event and any nested event. - - - - - Keeps track of the recursion level, - and throws - whenever is reached. - - - - - Increments the recursion level, - and throws - if is reached. - - - - - Increments the recursion level, - and returns whether is still less than . - - - - - Decrements the recursion level. - - - - - Specifies the style of a YAML scalar. - - - - - Let the emitter choose the style. - - - - - The plain scalar style. - - - - - The single-quoted scalar style. - - - - - The double-quoted scalar style. - - - - - The literal scalar style. - - - - - The folded scalar style. - - - - - Converts a sequence of characters into a sequence of YAML tokens. - - - - - Gets the current token. - - - - - Initializes a new instance of the class. - - The input. - Indicates whether comments should be ignored - - - - Gets the current position inside the input stream. - - The current position. - - - - Moves to the next token. - - - - - - Consumes the current token and increments the parsed token count - - - - - Check the list of potential simple keys and remove the positions that - cannot contain simple keys anymore. - - - - - Pop indentation levels from the indents stack until the current level - becomes less or equal to the column. For each indentation level, append - the BLOCK-END token. - - - - - Produce the STREAM-END token and shut down the scanner. - - - - - Scan a YAML-DIRECTIVE or TAG-DIRECTIVE token. - - Scope: - %YAML 1.1 # a comment \n - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - %TAG !yaml! tag:yaml.org,2002: \n - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - Produce the DOCUMENT-START or DOCUMENT-END token. - - - - - Produce the FLOW-SEQUENCE-START or FLOW-MAPPING-START token. - - - - - Increase the flow level and resize the simple key list if needed. - - - - - Produce the FLOW-SEQUENCE-END or FLOW-MAPPING-END token. - - - - - Decrease the flow level. - - - - - Produce the FLOW-ENTRY token. - - - - - Produce the BLOCK-ENTRY token. - - - - - Produce the KEY token. - - - - - Produce the VALUE token. - - - - - Push the current indentation level to the stack and set the new level - the current column is greater than the indentation level. In this case, - append or insert the specified token into the token queue. - - - - - Produce the ALIAS or ANCHOR token. - - - - - Produce the TAG token. - - - - - Scan a TAG token. - - - - - Produce the SCALAR(...,literal) or SCALAR(...,folded) tokens. - - - - - Scan a block scalar. - - - - - Scan indentation spaces and line breaks for a block scalar. Determine the - indentation level if needed. - - - - - Produce the SCALAR(...,single-quoted) or SCALAR(...,double-quoted) tokens. - - - - - Scan a quoted scalar. - - - - - Produce the SCALAR(...,plain) token. - - - - - Scan a plain scalar. - - - - - Remove a potential simple key at the current flow level. - - - - - Scan the directive name. - - Scope: - %YAML 1.1 # a comment \n - ^^^^ - %TAG !yaml! tag:yaml.org,2002: \n - ^^^ - - - - - Scan the value of VERSION-DIRECTIVE. - - Scope: - %YAML 1.1 # a comment \n - ^^^^^^ - - - - - Scan the value of a TAG-DIRECTIVE token. - - Scope: - %TAG !yaml! tag:yaml.org,2002: \n - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - Scan a tag. - - - - - Decode an URI-escape sequence corresponding to a single UTF-8 character. - - - - - Scan a tag handle. - - - - - Scan the version number of VERSION-DIRECTIVE. - - Scope: - %YAML 1.1 # a comment \n - ^ - %YAML 1.1 # a comment \n - ^ - - - - - Check if a simple key may start at the current position and add it if - needed. - - - - - Exception that is thrown when a semantic error is detected on a YAML stream. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Exception that is thrown when a syntax error is detected on a YAML stream. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Collection of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Initial content of the collection. - - - - - - - Gets a value indicating whether the collection contains a directive with the same handle - - - - - Represents an anchor token. - - - - - Gets the value. - - The value. - - - - Initializes a new instance of the class. - - The value. - - - - Initializes a new instance of the class. - - The value. - The start position of the token. - The end position of the token. - - - - Represents an alias token. - - - - - Gets the value of the alias. - - - - - Initializes a new instance of the class. - - The value of the anchor. - - - - Initializes a new instance of the class. - - The value of the anchor. - The start position of the event. - The end position of the event. - - - - Represents a block end token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a block entry event. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a block mapping start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a block sequence start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a comment - - - - - Gets the value of the comment - - - - - Gets a value indicating whether the comment appears other tokens on that line. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Represents a document end token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a document start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Base class for YAML tokens. - - - - - Gets the value of the comment - - - - - Represents a flow entry event. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a flow mapping end token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a flow mapping start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a flow sequence end token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a flow sequence start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a key token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a scalar token. - - - - - Gets the value. - - The value. - - - - Gets the style. - - The style. - - - - Initializes a new instance of the class. - - The value. - - - - Initializes a new instance of the class. - - The value. - The style. - - - - Initializes a new instance of the class. - - The value. - The style. - The start position of the token. - The end position of the token. - - - - Represents a stream end event. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a stream start token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a tag token. - - - - - Gets the handle. - - The handle. - - - - Gets the suffix. - - The suffix. - - - - Initializes a new instance of the class. - - The handle. - The suffix. - - - - Initializes a new instance of the class. - - The handle. - The suffix. - The start position of the token. - The end position of the token. - - - - Represents a tag directive token. - - - - - Gets the handle. - - The handle. - - - - Gets the prefix. - - The prefix. - - - - Initializes a new instance of the class. - - The handle. - The prefix. - - - - Initializes a new instance of the class. - - The handle. - The prefix. - The start position of the token. - The end position of the token. - - - - Determines whether the specified System.Object is equal to the current System.Object. - - The System.Object to compare with the current System.Object. - - true if the specified System.Object is equal to the current System.Object; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - - - - Base class for YAML tokens. - - - - - Gets the start of the token in the input stream. - - - - - Gets the end of the token in the input stream. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a value token. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start position of the token. - The end position of the token. - - - - Represents a version directive token. - - - - - Gets the version. - - The version. - - - - Initializes a new instance of the class. - - The version. - - - - Initializes a new instance of the class. - - The version. - The start position of the token. - The end position of the token. - - - - Determines whether the specified System.Object is equal to the current System.Object. - - The System.Object to compare with the current System.Object. - - true if the specified System.Object is equal to the current System.Object; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Specifies the version of the YAML language. - - - - - Gets the major version number. - - - - - Gets the minor version number. - - - - - Initializes a new instance of the class. - - The major version number. - The minor version number. - - - - Determines whether the specified System.Object is equal to the current System.Object. - - The System.Object to compare with the current System.Object. - - true if the specified System.Object is equal to the current System.Object; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Base exception that is thrown when the a problem occurs in the YamlDotNet library. - - - - - Gets the position in the input stream where the event that originated the exception starts. - - - - - Gets the position in the input stream where the event that originated the exception ends. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Returns the that describes the property that - is being returned in an expression in the form: - - x => x.SomeProperty - - - - - - Adapts an to - because not all generic collections implement . - - - - - Adapts an to - because not all generic dictionaries implement . - - - - - Gets or sets the element with the specified index. - - The index of the element to get or set. - The element with the specified index. - - - - Adds an element with the provided key and value to the - at the given index. - - The zero-based index at which the item should be inserted. - The object to use as the key of the element to add. - The object to use as the value of the element to add. - - - - Removes the element at the specified index. - - The zero-based index of the element to remove. - - - - Manages the state of a while it is loading. - - - - - Adds the specified node to the anchor list. - - The node. - - - - Gets the node with the specified anchor. - - The anchor. - The start position. - The end position. - - if there is no node with that anchor. - - - - Gets the node with the specified anchor. - - The anchor. - The node that was retrieved. - true if the anchor was found; otherwise false. - - - - Adds the specified node to the collection of nodes with unresolved aliases. - - - The that has unresolved aliases. - - - - - Resolves the aliases that could not be resolved while loading the document. - - - - - Holds state that is used when emitting a stream. - - - - - Gets the already emitted anchors. - - The emitted anchors. - - - - Defines the method needed to be able to visit Yaml elements. - - - - - Visits a . - - - The that is being visited. - - - - - Visits a . - - - The that is being visited. - - - - - Visits a . - - - The that is being visited. - - - - - Visits a . - - - The that is being visited. - - - - - Visits a . - - - The that is being visited. - - - - - Represents a LibYAML event stream. - - - - - Initializes a new instance of the class - from the specified . - - - - - Represents an alias node in the YAML document. - - - - - Initializes a new instance of the class. - - The anchor. - - - - Resolves the aliases that could not be resolved when the node was created. - - The state of the document. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Recursively enumerates all the nodes from the document, starting on the current node, - and throwing - if is reached. - - - - - Gets the type of node. - - - - - Represents an YAML document. - - - - - Gets or sets the root node. - - The root node. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a single scalar node. - - - - - Initializes a new instance of the class. - - - - - Visitor that assigns anchors to nodes that are referenced more than once. - Existing anchors are preserved as much as possible. - - - - - Key: Node, Value: IsDuplicate - - - - - Returns whether the visited node is a duplicate. - - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - Gets all nodes from the document. - is thrown if an infinite recursion is detected. - - - - - Represents a mapping node in the YAML document. - - - - - Gets the children of the current node. - - The children. - - - - Gets or sets the style of the node. - - The style. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - A sequence of where even elements are keys and odd elements are values. - - - - Initializes a new instance of the class. - - A sequence of where even elements are keys and odd elements are values. - - - - Adds the specified mapping to the collection. - - The key node. - The value node. - - - - Adds the specified mapping to the collection. - - The key node. - The value node. - - - - Adds the specified mapping to the collection. - - The key node. - The value node. - - - - Adds the specified mapping to the collection. - - The key node. - The value node. - - - - Resolves the aliases that could not be resolved when the node was created. - - The state of the document. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Recursively enumerates all the nodes from the document, starting on the current node, - and throwing - if is reached. - - - - - Gets the type of node. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - - - - Creates a containing a key-value pair for each property of the specified object. - - - - - Represents a single node in the YAML document. - - - - - Gets or sets the anchor of the node. - - The anchor. - - - - Gets or sets the tag of the node. - - The tag. - - - - Gets the position in the input stream where the event that originated the node starts. - - - - - Gets the position in the input stream where the event that originated the node ends. - - - - - Loads the specified event. - - The event. - The state of the document. - - - - Parses the node represented by the next event in . - - Returns the node that has been parsed. - - - - Resolves the aliases that could not be resolved when the node was created. - - The state of the document. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - Gets all nodes from the document, starting on the current node. - is thrown if an infinite recursion is detected. - - - - - When implemented, recursively enumerates all the nodes from the document, starting on the current node. - If is reached, a is thrown - instead of continuing and crashing with a . - - - - - Gets the type of node. - - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from string[] to . - - The value. - The result of the conversion. - - - - Converts a to a string by returning its value. - - - - - Gets the nth element in a . - - - - - Gets the value associated with a key in a . - - - - - Comparer that is based on identity comparisons. - - - - - - - - - - - Specifies the type of node in the representation model. - - - - - The node is a . - - - - - The node is a . - - - - - The node is a . - - - - - The node is a . - - - - - Represents a scalar node in the YAML document. - - - - - Gets or sets the value of the node. - - The value. - - - - Gets or sets the style of the node. - - The style. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - - - - Resolves the aliases that could not be resolved when the node was created. - - The state of the document. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Recursively enumerates all the nodes from the document, starting on the current node, - and throwing - if is reached. - - - - - Gets the type of node. - - - - - Represents a sequence node in the YAML document. - - - - - Gets the collection of child nodes. - - The children. - - - - Gets or sets the style of the node. - - The style. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Adds the specified child to the collection. - - The child. - - - - Adds a scalar node to the collection. - - The child. - - - - Resolves the aliases that could not be resolved when the node was created. - - The state of the document. - - - - Saves the current node to the specified emitter. - - The emitter where the node is to be saved. - The state. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Recursively enumerates all the nodes from the document, starting on the current node, - and throwing - if is reached. - - - - - Gets the type of node. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - - - - Represents an YAML stream. - - - - - Gets the documents inside the stream. - - The documents. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Adds the specified document to the collection. - - The document. - - - - Loads the stream from the specified input. - - The input. - - - - Loads the stream from the specified . - - - - - Saves the stream to the specified output. - - The output. - - - - Saves the stream to the specified output. - - The output. - Indicates whether or not to assign node anchors. - - - - Saves the stream to the specified emitter. - - The emitter. - Indicates whether or not to assign node anchors. - - - - Accepts the specified visitor by calling the appropriate Visit method on it. - - - A . - - - - - - - - Abstract implementation of that knows how to walk a complete Yaml object model. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called after this object finishes visiting a . - - - The that has been visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called after this object finishes visiting a . - - - The that has been visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called after this object finishes visiting a . - - - The that has been visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called after this object finishes visiting a . - - - The that has been visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called after this object finishes visiting a . - - - The that has been visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Abstract implementation of that knows how to walk a complete YAML object model. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called when this object is visiting a . - - - The that is being visited. - - - - - Called when this object is visiting a key-value pair. - - The left (key) that is being visited. - The right (value) that is being visited. - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Visits every child of a . - - - The that is being visited. - - - - - Common implementation of and . - - - - - Prevents serialization and deserialization of fields. - - - - - - Allows serialization and deserialization of non-public properties. - - - - - Sets the that will be used by the (de)serializer. - - - - - Sets the that will be used by the (de)serializer. - - - - - Register an for a given property. - - - An expression in the form: x => x.SomeProperty - The attribute to register. - - - - - Register an for a given property. - - - - - Registers an additional to be used by the (de)serializer. - - - - - Registers an additional to be used by the (de)serializer. - - - Configures the location where to insert the - - - - Registers an additional to be used by the (de)serializer. - - A factory that creates the based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Registers an additional to be used by the (de)serializer. - - A function that instantiates the type inspector. - - - - Registers an additional to be used by the (de)serializer. - - A function that instantiates the type inspector. - Configures the location where to insert the - - - - Registers an additional to be used by the (de)serializer. - - A function that instantiates the type inspector based on a previously registered .. - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - A factory that creates instances of based on an existing . - - The type of the wrapped component. - The type of the component that this factory creates. - The component that is to be wrapped. - Returns a new instance of that is based on . - - - - A factory that creates instances of based on an existing and an argument. - - The type of the argument. - The type of the wrapped component. - The type of the component that this factory creates. - The component that is to be wrapped. - The argument of the factory. - Returns a new instance of that is based on and . - - - - This represents the YAML converter entity for . - - - - - Initializes a new instance of the class. - - value. Default value is . is considered as . - instance. Default value is . - List of date/time formats for parsing. Default value is "G". - On deserializing, all formats in the list are used for conversion, while on serializing, the first format in the list is used. - - - - Gets a value indicating whether the current converter supports converting the specified type. - - to check. - Returns True, if the current converter supports; otherwise returns False. - - - - Reads an object's state from a YAML parser. - - instance. - to convert. - Returns the instance converted. - On deserializing, all formats in the list are used for conversion. - - - - Writes the specified object's state to a YAML emitter. - - instance. - Value to write. - to convert. - On serializing, the first format in the list is used. - - - - Converter for System.Guid. - - - - - Converter for System.Type. - - - Converts to a scalar containing the assembly qualified name of the type. - - - - - Specifies the strategy to handle default and null values during serialization of properties. - - - - - Specifies that all properties are to be emitted regardless of their value. This is the default behavior. - - - - - Specifies that properties that contain null references or a null Nullable<T> are to be omitted. - - - - - Specifies that properties that that contain their default value, either default(T) or the value specified in DefaultValueAttribute are to be omitted. - - - - - Specifies that properties that that contain collections/arrays/enumerations that are empty are to be omitted. - - - - - Deserializes objects from the YAML format. - To customize the behavior of , - use the class. - - - - - Initializes a new instance of using the default configuration. - - - To customize the behavior of the deserializer, use . - - - - - This constructor is private to discourage its use. - To invoke it, call the method. - - - - - Creates a new that uses the specified . - This method is available for advanced scenarios. The preferred way to customize the behavior of the - deserializer is to use . - - - - - Deserializes an object of the specified type. - - The from where to deserialize the object. - The static type of the object to deserialize. - Returns the deserialized object. - - - - Creates and configures instances of . - This class is used to customize the behavior of . Use the relevant methods - to apply customizations, then call to create an instance of the deserializer - with the desired customizations. - - - - - Initializes a new using the default component registrations. - - - - - Sets the that will be used by the deserializer. - - - - - Sets the that will be used by the deserializer. - - - - - Registers an additional to be used by the deserializer. - - - - - Registers an additional to be used by the deserializer. - - - Configures the location where to insert the - - - - Registers an additional to be used by the deserializer. - - A factory that creates the based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Registers an additional to be used by the deserializer. - - - - - Registers an additional to be used by the deserializer. - - - Configures the location where to insert the - - - - Registers an additional to be used by the deserializer. - - A factory that creates the based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Registers a tag mapping. - - - - - Registers a type mapping using the default object factory. - - - - - Unregisters an existing tag mapping. - - - - - Instructs the deserializer to ignore unmatched properties instead of throwing an exception. - - - - - Creates a new according to the current configuration. - - - - - Creates a new that implements the current configuration. - This method is available for advanced scenarios. The preferred way to customize the behavior of the - deserializer is to use the method. - - - - - Gets the next visitor that should be called by the current visitor. - - - - - Gets the that is to be used for serialization. - - - - - Gets a function that, when called, serializes the specified object. - - - - - Gets the visitor of type that was used during the pre-processing phase. - - The type of the visitor.s - - - No visitor of that type has been registered, - or ore than one visitors registered are of type . - - - - - Provided the base implementation for an IEventEmitter that is a - decorator for another IEventEmitter. - - - - - Deserializes an object of the specified type. - - The from where to deserialize the object. - The static type of the object to deserialize. - Returns the deserialized object. - - - - Translates property names according to a specific convention. - - - - - Determines the type of the specified node. - - The node to be deserialized. - The type that has been determined so far. - - true if has been resolved completely; - false if the next type should be invoked. - - - - - Represents an object along with its type. - - - - - A reference to the object. - - - - - The type that should be used when to interpret the . - - - - - The type of as determined by its container (e.g. a property). - - - - - The style to be used for scalars. - - - - - Returns the Value property of the if it is not null. - This is useful in all places that the value must not be null. - - An object descriptor. - Thrown when the Value is null - - - - - Creates instances of types. - - - This interface allows to provide a custom logic for creating instances during deserialization. - - - - - Creates an instance of the specified type. - - - - - Defines a strategy that walks through an object graph. - - - - - Traverses the specified object graph. - - The graph. - An that is to be notified during the traversal. - A that will be passed to the . - - - - Defined the interface of a type that can be notified during an object graph traversal. - - - - - Indicates whether the specified value should be entered. This allows the visitor to - override the handling of a particular object or type. - - The value that is about to be entered. - The context that this implementation depend on. - If the value is to be entered, returns true; otherwise returns false; - - - - Indicates whether the specified mapping should be entered. This allows the visitor to - override the handling of a particular pair. - - The key of the mapping that is about to be entered. - The value of the mapping that is about to be entered. - The context that this implementation depend on. - If the mapping is to be entered, returns true; otherwise returns false; - - - - Indicates whether the specified mapping should be entered. This allows the visitor to - override the handling of a particular pair. This overload should be invoked when the - mapping is produced by an object's property. - - The that provided access to . - The value of the mapping that is about to be entered. - The context that this implementation depend on. - If the mapping is to be entered, returns true; otherwise returns false; - - - - Notifies the visitor that a scalar value has been encountered. - - The value of the scalar. - The context that this implementation depend on. - - - - Notifies the visitor that the traversal of a mapping is about to begin. - - The value that corresponds to the mapping. - The static type of the keys of the mapping. - The static type of the values of the mapping. - The context that this implementation depend on. - - - - Notifies the visitor that the traversal of a mapping has ended. - - The value that corresponds to the mapping. - The context that this implementation depend on. - - - - Notifies the visitor that the traversal of a sequence is about to begin. - - The value that corresponds to the sequence. - The static type of the elements of the sequence. - The context that this implementation depend on. - - - - Notifies the visitor that the traversal of a sequence has ended. - - The value that corresponds to the sequence. - The context that this implementation depend on. - - - - Registers the component in place of the already registered component of type . - - - - - Registers the component before the already registered component of type . - - - - - Registers the component after the already registered component of type . - - - - - Registers the component before every other previously registered component. - - - - - Registers the component after every other previously registered component. - - - - - Registers the component in place of the already registered component of type . - - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - - - - Serializes the specified object into a string. - - The object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - The static type of the object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - The static type of the object to serialize. - - - - Provides access to the properties of a type. - - - - - Gets all properties of the specified type. - - The type whose properties are to be enumerated. - The actual object of type whose properties are to be enumerated. Can be null. - - - - - Gets the property of the type with the specified name. - - The type whose properties are to be searched. - The actual object of type whose properties are to be searched. Can be null. - The name of the property. - - Determines if an exception or null should be returned if can't be - found in - - - - - - Resolves the type of values. - - - - - Allows an object to customize how it is serialized and deserialized. - - - - - Reads this object's state from a YAML parser. - - The parser where the object's state should be read from. - The type that the deserializer is expecting. - - A function that will use the current deserializer - to read an object of the given type from the parser. - - - - - Writes this object's state to a YAML emitter. - - The emitter where the object's state should be written to. - A function that will use the current serializer to write an object to the emitter. - - - - Represents a function that is used to deserialize an object of the given type. - - The type that the deserializer should read. - Returns the object that was deserialized. - - - - Represents a function that is used to serialize an object of the given type. - - The object to be serialized. - - The type that should be considered when emitting the object. - If null, the actual type of the is used. - - - - - Allows an object to customize how it is serialized and deserialized. - - - - - Reads this object's state from a YAML parser. - - - - - Writes this object's state to a YAML emitter. - - - - - Allows to customize how a type is serialized and deserialized. - - - - - Gets a value indicating whether the current converter supports converting the specified type. - - - - - Reads an object's state from a YAML parser. - - - - - Writes the specified object's state to a YAML emitter. - - - - - Convert the string with underscores (this_is_a_test) or hyphens (this-is-a-test) to - camel case (thisIsATest). Camel case is the same as Pascal case, except the first letter - is lowercase. - - - - - Convert the string from camelcase (thisIsATest) to a hyphenated (this-is-a-test) string - - - - - Convert the string with underscores (this_is_a_test) or hyphens (this-is-a-test) to - pascal case (ThisIsATest). Pascal case is the same as camel case, except the first letter - is uppercase. - - - - - Performs no naming conversion. - - - - - Convert the string with underscores (this_is_a_test) or hyphens (this-is-a-test) to - pascal case (ThisIsATest). Pascal case is the same as camel case, except the first letter - is uppercase. - - - - - Convert the string from camelcase (thisIsATest) to a underscored (this_is_a_test) string - - - - - An empty type for cases where a type needs to be provided but won't be used. - - - - - Creates objects using Activator.CreateInstance. - - - - - Creates objects using a Func{Type,object}"/>. - - - - - An implementation of that traverses - readable properties, collections and dictionaries. - - - - - An implementation of that traverses - properties that are read/write, collections and dictionaries, while ensuring that - the graph can be regenerated from the resulting document. - - - - - A factory method for creating instances - - The type inspector to be used by the traversal strategy. - The type resolver to be used by the traversal strategy. - The type converters to be used by the traversal strategy. - The maximum object depth to be supported by the traversal strategy. - - - - - A base class that simplifies the correct implementation of . - - - - - Initializes a new instance of using the default configuration. - - - To customize the behavior of the serializer, use . - - - - - This constructor is private to discourage its use. - To invoke it, call the method. - - - - - Creates a new that uses the specified . - This method is available for advanced scenarios. The preferred way to customize the behavior of the - deserializer is to use . - - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - - - - Serializes the specified object into a string. - - The object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - The static type of the object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - - - - Serializes the specified object. - - The where to serialize the object. - The object to serialize. - The static type of the object to serialize. - - - - Creates and configures instances of . - This class is used to customize the behavior of . Use the relevant methods - to apply customizations, then call to create an instance of the serializer - with the desired customizations. - - - - - Sets the maximum recursion that is allowed while traversing the object graph. The default value is 50. - - - - - Registers an additional to be used by the serializer. - - A function that instantiates the event emitter. - - - - Registers an additional to be used by the serializer. - - A function that instantiates the event emitter. - Configures the location where to insert the - - - - Registers an additional to be used by the serializer. - - A function that instantiates the event emitter based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Registers a tag mapping. - - - - - Unregisters an existing tag mapping. - - - - - Ensures that it will be possible to deserialize the serialized objects. - This option will force the emission of tags and emit only properties with setters. - - - - - Specifies that, if the same object appears more than once in the - serialization graph, it will be serialized each time instead of just once. - - - If the serialization graph contains circular references and this flag is set, - a StackOverflowException will be thrown. - If this flag is not set, there is a performance penalty because the entire - object graph must be walked twice. - - - - - Forces every value to be serialized, even if it is the default value for that type. - - - - - Configures how properties with default and null values should be handled. The default value is DefaultValuesHandling.Preserve - - - If more control is needed, create a class that extends from ChainedObjectGraphVisitor and override its EnterMapping methods. - Then register it as follows: - WithEmissionPhaseObjectGraphVisitor(args => new MyDefaultHandlingStrategy(args.InnerVisitor)); - - - - - Ensures that the result of the serialization is valid JSON. - - - - - Registers an additional to be used by the serializer - before emitting an object graph. - - - Registering a visitor in the pre-processing phase enables to traverse the object graph once - before actually emitting it. This allows a visitor to collect information about the graph that - can be used later by another visitor registered in the emission phase. - - The type inspector. - - - - Registers an additional to be used by the serializer - before emitting an object graph. - - - Registering a visitor in the pre-processing phase enables to traverse the object graph once - before actually emitting it. This allows a visitor to collect information about the graph that - can be used later by another visitor registered in the emission phase. - - The type inspector. - Configures the location where to insert the - - - - Registers an additional to be used by the serializer - before emitting an object graph. - - - Registering a visitor in the pre-processing phase enables to traverse the object graph once - before actually emitting it. This allows a visitor to collect information about the graph that - can be used later by another visitor registered in the emission phase. - - A factory that creates the based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Registers an to be used by the serializer - while traversing the object graph. - - A function that instantiates the traversal strategy. - - - - Registers an additional to be used by the serializer - while emitting an object graph. - - A function that instantiates the type inspector. - - - - Registers an additional to be used by the serializer - while emitting an object graph. - - A function that instantiates the type inspector. - Configures the location where to insert the - - - - Registers an additional to be used by the serializer - while emitting an object graph. - - A function that instantiates the type inspector based on a previously registered . - Configures the location where to insert the - - - - Unregisters an existing of type . - - - - - Unregisters an existing of type . - - - - - Creates sequences with extra indentation - - - list: - - item - - item - - - - - - Creates a new according to the current configuration. - - - - - Creates a new that implements the current configuration. - This method is available for advanced scenarios. The preferred way to customize the behavior of the - deserializer is to use the method. - - - - - An object that contains part of a YAML stream. - - - - - Gets or sets the events. - - The events. - - - - Reads this object's state from a YAML parser. - - - - - Writes this object's state to a YAML emitter. - - - - - Contains mappings between tags and types. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The mappings. - - - - Adds the specified tag. - - The tag. - The mapping. - - - - Gets the mapping. - - The tag. - - - - - Wraps another and applies caching. - - - - - Aggregates the results from multiple into a single one. - - - - - Wraps another and applies a - naming convention to the names of the properties. - - - - - Returns the properties of a type that are both readable and writable. - - - - - Returns the properties and fields of a type that are readable. - - - - - Returns the properties of a type that are readable. - - - - - The type returned will be the actual type of the value, if available. - - - - - The type returned will always be the static type. - - - - - Indicates that a class used as deserialization state - needs to be notified after deserialization. - - - - - Adds the specified anchor. - - The anchor. - The @object. - - - - Gets the anchor for the specified object. - - The object. - The anchor. - - - - - Gets the with the specified anchor. - - - - - - A generic container that is preserved during the entire deserialization process. - Any disposable object added to this collection will be disposed when this object is disposed. - - - - - Invokes on all - objects added to this collection that implement . - - - - - Various string extension methods - - - - - Convert the string with underscores (this_is_a_test) or hyphens (this-is-a-test) to - camel case (thisIsATest). Camel case is the same as Pascal case, except the first letter - is lowercase. - - String to convert - Converted string - - - - Convert the string with underscores (this_is_a_test) or hyphens (this-is-a-test) to - pascal case (ThisIsATest). Pascal case is the same as camel case, except the first letter - is uppercase. - - String to convert - Converted string - - - - Convert the string from camelcase (thisIsATest) to a hyphenated (this-is-a-test) or - underscored (this_is_a_test) string - - String to convert - Separator to use between segments - Converted string - - - - Performs type conversions using every standard provided by the .NET library. - - - - - Converts the specified value. - - The type to which the value is to be converted. - The value to convert. - - - - - Converts the specified value. - - The type to which the value is to be converted. - The value to convert. - The provider. - - - - - Converts the specified value. - - The type to which the value is to be converted. - The value to convert. - The culture. - - - - - Converts the specified value using the invariant culture. - - The value to convert. - The type to which the value is to be converted. - - - - - Converts the specified value. - - The value to convert. - The type to which the value is to be converted. - The format provider. - - - - - Converts the specified value. - - The value to convert. - The type to which the value is to be converted. - The culture. - - - - - Registers a dynamically. - - The type to which the converter should be associated. - The type of the converter. - - - - Define a collection of YamlAttribute Overrides for pre-defined object types. - - - - - Checks whether this mapping matches the specified type, and returns a value indicating the match priority. - - The priority of the match. Higher values have more priority. Zero indicates no match. - - - - Adds a Member Attribute Override - - Type - Class Member - Overriding Attribute - - - - Creates a copy of this instance. - - - - - Adds a Member Attribute Override - - - - - Applies the Yaml attribute overrides to another . - - - - - Applies the Yaml* attributes to another . - - - - - Instructs the YamlSerializer not to serialize the public field or public read/write property value. - - - - - Provides special Yaml serialization instructions. - - - - - Decription/Comment about this property. - When set, a comment will be emitted when serializing this member. - - - - - Specifies that this property should be serialized as the given type, rather than using the actual runtime value's type. - - - - - Specifies the order priority of this property. - - - - - Instructs the to use a different field name for serialization. - - - - - When false, naming conventions will not be applied to this member. Defaults to true. - - - - - Specifies the scalar style of the property when serialized. This will only affect the serialization of scalar properties. - - - - - Overrides how null and default values should be handled for this property. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Specifies that this property should be serialized as the given type, rather than using the actual runtime value's type. - - - - Determines whether the specified type has a default constructor. - - The type. - - true if the type has a default constructor; otherwise, false. - - - - - Specifies that is allowed as an input even if the - corresponding type disallows it. - - - - - Initializes a new instance of the class. - - - - - Specifies that is disallowed as an input even if the - corresponding type allows it. - - - - - Initializes a new instance of the class. - - - - - Specifies that a method that will never return under any circumstance. - - - - - Initializes a new instance of the class. - - - - - Specifies that the method will not return if the associated - parameter is passed the specified value. - - - - - Gets the condition parameter value. - Code after the method is considered unreachable by diagnostics if the argument - to the associated parameter matches this value. - - - - - Initializes a new instance of the - class with the specified parameter value. - - - The condition parameter value. - Code after the method is considered unreachable by diagnostics if the argument - to the associated parameter matches this value. - - - - - Specifies that an output may be even if the - corresponding type disallows it. - - - - - Initializes a new instance of the class. - - - - - Specifies that when a method returns , - the parameter may be even if the corresponding type disallows it. - - - - - Gets the return value condition. - If the method returns this value, the associated parameter may be . - - - - - Initializes the attribute with the specified return value condition. - - - The return value condition. - If the method returns this value, the associated parameter may be . - - - - - Specifies that an output is not even if the - corresponding type allows it. - - - - - Initializes a new instance of the class. - - - - - Specifies that the output will be non- if the - named parameter is non-. - - - - - Gets the associated parameter name. - The output will be non- if the argument to the - parameter specified is non-. - - - - - Initializes the attribute with the associated parameter name. - - - The associated parameter name. - The output will be non- if the argument to the - parameter specified is non-. - - - - - Specifies that when a method returns , - the parameter will not be even if the corresponding type allows it. - - - - - Gets the return value condition. - If the method returns this value, the associated parameter will not be . - - - - - Initializes the attribute with the specified return value condition. - - - The return value condition. - If the method returns this value, the associated parameter will not be . - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml.meta deleted file mode 100644 index cc523112..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/YamlDotNet.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7216842dba265a841b1727c19c23a3f3 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts.meta deleted file mode 100644 index a634c6ea..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: b8afe2e23b880ca44875749bc68bd99d -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef deleted file mode 100644 index 94162436..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef +++ /dev/null @@ -1,17 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.Runtime", - "references": [], - "optionalUnityReferences": [], - "includePlatforms": [ - "Editor", - "WindowsStandalone64" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef deleted file mode 100644 index e25e67c9..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name": "AmazonGameLiftPlugin.Editor.UnitTests", - "references": [ - "AmazonGameLiftPlugin.Editor", - "AmazonGameLiftPlugin.EditorCoreAPI" - ], - "optionalUnityReferences": [ - "TestAssemblies" - ], - "includePlatforms": [ - "Editor" - ], - "excludePlatforms": [], - "allowUnsafeCode": false, - "overrideReferences": true, - "precompiledReferences": [ - "Moq.dll", - "AmazonGameLiftPlugin.Core.dll" - ], - "autoReferenced": true, - "defineConstraints": [] -} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.dll.meta deleted file mode 100644 index b51f575e..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.dll.meta +++ /dev/null @@ -1,93 +0,0 @@ -fileFormatVersion: 2 -guid: 9f93fbb1ffaa32043b073866aa0b2abf -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 1 - Exclude LinuxUniversal: 1 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 1 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: LinuxUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: x86 - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml deleted file mode 100644 index 6c8f6b74..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml +++ /dev/null @@ -1,6057 +0,0 @@ - - - - Castle.Core - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Gets a value indicating whether the object has a fixed size. - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - An object containing the keys of the object. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Gets an object containing the values in the object. - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Gets the number of elements contained in the . - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - An object that can be used to synchronize access to the . - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Abstract implementation of . - - - - - Identifies a property should be represented as a nested component. - - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Assigns a specific dictionary key. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Suppresses any on-demand behaviors. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Specifies assignment by reference rather than by copying. - - - - - Removes a property if matches value. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Initializes a new instance of the class - that represents a child object in a larger object graph. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wraps a with a dynamic object to expose a bit better looking API. - The implementation is trivial and assumes keys are s. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - Contract for traversing a . - - - - - Defines the contract for customizing dictionary access. - - - - - Determines relative order to apply related behaviors. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Contract for managing Dictionary adapter notifications. - - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for validating Dictionary adapter. - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - - - - - - Initializes a new instance of the class. - - The name values. - - - - Gets a value indicating whether the object is read-only. - - true if the object is read-only; otherwise, false. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Gets or sets the with the specified key. - - - - - Adapts the specified name values. - - The name values. - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existing instance of the class. - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - Copies the - - - - - Provides a generic collection that supports data binding. - - - This class wraps the CLR - in order to implement the Castle-specific . - - The type of elements in the list. - - - - Initializes a new instance of the class - using default values. - - - - - Initializes a new instance of the class - with the specified list. - - - An of items - to be contained in the . - - - - - Initializes a new instance of the class - wrapping the specified instance. - - - A - to be wrapped by the . - - - - - Contract for value matching. - - - - - Contract for dynamic value resolution. - - - - - Contract for typed dynamic value resolution. - - - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - Deserializes the specified node into an abstract representation of configuration. - - The node. - - - - If a config value is an empty string we return null, this is to keep - backward compatibility with old code - - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The type. - The type attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The type. - The type attributes. - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - Checks whether or not collection is null or empty. Assumes collection can be safely enumerated multiple times. - - - - - Generates a HashCode for the contents for the list. Order of items does not matter. - - The type of object contained within the list. - The list. - The generated HashCode. - - - - Determines if two lists are equivalent. Equivalent lists have the same number of items and each item is found within the other regardless of respective position within each. - - The type of object contained within the list. - The first list. - The second list. - True if the two lists are equivalent. - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Creates a new lock. - - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - Gets the configuration file. - - i.e. log4net.config - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Logger using standard Diagnostics namespace. - - - - - Creates a logger based on . - - - - - - Creates a logger based on . - - - - - - - Creates a logger based on . - - - - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - Provides a factory that can produce either or - classes. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Determines if messages of priority "trace" will be logged. - - True if "trace" messages will be logged. - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a trace message. - - The message to log - - - - Logs a trace message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs a trace message. - - The exception to log - The message to log - - - - Logs a trace message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - The Level Filtered Logger class. This is a base class which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Keep the instance alive in a remoting scenario - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Logs a trace message. - - The message to log - - - - Logs a trace message. - - A functor to create the message - - - - Logs a trace message. - - The exception to log - The message to log - - - - Logs a trace message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a trace message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "trace" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Trace logging level - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - Creates outputting - to files. The name of the file is derived from the log name - plus the 'log' extension. - - - - - The TraceLogger sends all logging to the System.Diagnostics.TraceSource - built into the .net framework. - - - Logging can be configured in the system.diagnostics configuration - section. - - If logger doesn't find a source name with a full match it will - use source names which match the namespace partially. For example you can - configure from all castle components by adding a source name with the - name "Castle". - - If no portion of the namespace matches the source named "Default" will - be used. - - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - The default logging level at which this source should write messages. In almost all cases this - default value will be overridden in the config file. - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - - - - Used to create the TraceLogger implementation of ILogger interface. See . - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Gets the number of elements contained in the . - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - Gets an object containing the keys of the object. - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - true if the object has a fixed size; otherwise, false. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - - - - - - - - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Only valid for resources that - can be obtained through relative paths - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - Creates an instance - for the given resource identifier - - - - - Creates an instance - for the given resource identifier - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - - Default implementation. - - - - - Initializes a new instance of the class based on the configuration provided in the application configuration file. - - - This constructor is based on the default configuration in the application configuration file. - - - - - This service implementation - requires a host name in order to work - - The smtp server name - - - - Gets or sets the port used to - access the SMTP server - - - - - Gets the hostname. - - The hostname. - - - - Gets or sets a value which is used to - configure if emails are going to be sent asynchronously or not. - - - - - Gets or sets a value that specifies - the amount of time after which a synchronous Send call times out. - - - - - Gets or sets a value indicating whether the email should be sent using - a secure communication channel. - - true if should use SSL; otherwise, false. - - - - Sends a message. - - If any of the parameters is null - From field - To field - e-mail's subject - message's body - - - - Sends a message. - - If the message is null - Message instance - - - - Gets or sets the domain. - - The domain. - - - - Gets or sets the name of the user. - - The name of the user. - - - - Gets or sets the password. - - The password. - - - - Configures the sender - with port information and eventual credential - informed - - Message instance - - - - Gets a value indicating whether credentials were informed. - - - if this instance has credentials; otherwise, . - - - - - Email sender abstraction. - - - - - Sends a mail message. - - From field - To field - E-mail's subject - message's body - - - - Sends a message. - - Message instance - - - - Sends multiple messages. - - List of messages - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - Encapsulates the information needed to build an attribute. - - - Arrays passed to this class as constructor arguments or property or field values become owned by this class. - They should not be mutated after creation. - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Provides instructions that a user could follow to make a type or method in - visible to DynamicProxy. - The assembly containing the type or method. - Instructions that a user could follow to make a type or method visible to DynamicProxy. - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Represents the scope of uniqueness of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibility of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Generates the constructor for the class that extends - - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overridden, or null. - The add method. - The remove method. - The attributes. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Exposes means to change target objects of proxies and invocations. - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Provides the main DynamicProxy extension point that allows member interception. - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type of the target object. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Returns an object describing the operation for this - at this specific point during interception. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Describes the operation for an - at a specific point during interception. - - - - - Executes the operation described by this instance. - - There is no interceptor, nor a proxy target object, to proceed to. - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - Checks whether the specified is a delegate type (i.e. a direct subclass of ). - - - - - Abstracts the implementation of proxy type construction. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Provides proxy objects for classes and interfaces. - - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Exposes access to the target object and interceptors of proxy objects. - This is a DynamicProxy infrastructure interface and should not be implemented yourself. - - - - - Get the proxy target (note that null is a valid target!) - - - - - Set the proxy target. - - New proxy target. - - - - Gets the interceptors for the proxy - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Users of this should use this lock when accessing the cache. - - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the directory where the strongly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the strongly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Gets the directory where the weakly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the weakly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Saves the generated assembly with the name and directory information given when this instance was created (or with - the and current directory if none was given). - - - - This method stores the generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). If both a strong-named and a weak-named assembly - have been generated, it will throw an exception; in this case, use the overload. - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - Both a strong-named and a weak-named assembly have been generated. - The path of the generated assembly file, or null if no file has been generated. - - - - Saves the specified generated assembly with the name and directory information given when this instance was created - (or with the and current directory if none was given). - - True if the generated assembly with a strong name should be saved (see ); - false if the generated assembly without a strong name should be saved (see . - - - This method stores the specified generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - No assembly has been generated that matches the parameter. - - The path of the generated assembly file, or null if no file has been generated. - - - - Loads the generated types from the given assembly into this 's cache. - - The assembly to load types from. This assembly must have been saved via or - , or it must have the manually applied. - - This method can be used to load previously generated and persisted proxy types from disk into this scope's type cache, e.g. in order - to avoid the performance hit associated with proxy generation. - - - - - ProxyBuilder that persists the generated type. - - - The saved assembly contains just the last generated type. - - - - - Initializes a new instance of the class. - - - - - Saves the generated assembly to a physical file. Note that this renders the unusable. - - The path of the generated assembly file, or null if no assembly has been generated. - - This method does not support saving multiple files. If both a signed and an unsigned module have been generated, use the - respective methods of the . - - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Adds a delegate type to the list of mixins that will be added to generated proxies. - That is, generated proxies will have a `Invoke` method with a signature matching that - of the specified . - - The delegate type whose `Invoke` method should be reproduced in generated proxies. - is . - is not a delegate type. - - - - Adds a delegate to be mixed into generated proxies. The - will act as the target for calls to a `Invoke` method with a signature matching that - of the delegate. - - The delegate that should act as the target for calls to `Invoke` methods with a matching signature. - is . - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates a delegate of the specified type to a suitable `Invoke` method - on the given instance. - - The proxy instance to which the delegate should be bound. - The type of delegate that should be created. - - The does not have an `Invoke` method that is compatible with - the requested type. - - - - - Creates a delegate of the specified type to a suitable `Invoke` method - on the given instance. - - The proxy instance to which the delegate should be bound. - The type of delegate that should be created. - - The does not have an `Invoke` method that is compatible with - the requested . - - - - - Checks whether the specified method is accessible to DynamicProxy. - The method to check. - true if the method is accessible to DynamicProxy, false otherwise. - - - - Checks whether the specified method is accessible to DynamicProxy. - The method to check. - If the method is accessible to DynamicProxy, null; otherwise, an explanation of why the method is not accessible. - true if the method is accessible to DynamicProxy, false otherwise. - - - - Checks whether the specified type is accessible to DynamicProxy. - The type to check. - true if the type is accessible to DynamicProxy, false otherwise. - - - - Determines whether this assembly has internals visible to DynamicProxy. - - The assembly to inspect. - - - - Checks whether the specified method is accessible to DynamicProxy. - Unlike with , the declaring type's accessibility is ignored. - - The method to check. - true if the method is accessible to DynamicProxy, false otherwise. - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Applied to the assemblies saved by in order to persist the cache data included in the persisted assembly. - - - - - Handles the deserialization of proxies. - - - - - Resets the used for deserialization to a new scope. - - - This is useful for test cases. - - - - - Resets the used for deserialization to a given . - - The scope to be used for deserialization. - - By default, the deserialization process uses a different scope than the rest of the application, which can lead to multiple proxies - being generated for the same type. By explicitly setting the deserialization scope to the application's scope, this can be avoided. - - - - - Gets the used for deserialization. - - As has no way of automatically determining the scope used by the application (and the application might use more than one scope at the same time), uses a dedicated scope instance for deserializing proxy types. This instance can be reset and set to a specific value via and . - - - - Holds objects representing methods of class. - - - - - Holds objects representing methods of class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml.meta deleted file mode 100644 index fc004ddd..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Castle.Core.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 714e691934d6a164592765d2382f17e5 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.dll.meta deleted file mode 100644 index a1cf095a..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.dll.meta +++ /dev/null @@ -1,93 +0,0 @@ -fileFormatVersion: 2 -guid: 7f30f73687022c742b1b0749f72b2e30 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 1 - Exclude LinuxUniversal: 1 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 1 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: LinuxUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: x86 - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml deleted file mode 100644 index 4370de06..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml +++ /dev/null @@ -1,7815 +0,0 @@ - - - - Moq - - - - - is a kind of that works by - applying a delegate to a light-weight proxy that records the invocation - happening to it, and auto-generates the same kind of recording proxy for its return value. - That way, a chain of invocation records is generated from which a LINQ expression tree can be - reconstructed. - - - - - Recursively gets the result of (i.e. "unwraps") completed awaitables - until a value is found that isn't a successfully completed awaitable. - - - As an example, given := Task.FromResult(Task.FromResult(42)), - this method will return 42. - - The (possibly awaitable) object to be "unwrapped". - - - - Abstract base class that facilitates type-safe implementation of - for awaitables that do not produce a result when awaited. - - - - - Abstract base class that facilitates type-safe implementation of - for awaitables that produce a result when awaited. - - - - - Allows to create parameter captures in setup expressions. - - - - - Creates a parameter capture that will store values in a collection. - - The captured object type - The collection that will store captured parameter values - - Arrange code: - - var parameters = new List{string}(); - mock.Setup(x => x.DoSomething(Capture.In(parameters))); - - Assert code: - - Assert.Equal("Hello!", parameters.Single()); - - - - - - Creates a parameter capture that will store specific values in a collection. - - The captured object type - The collection that will store captured parameter values - A predicate used to filter captured parameters - - Arrange code: - - var parameters = new List{string}(); - mock.Setup(x => x.DoSomething(Capture.In(parameters, p => p.StartsWith("W")))); - - Assert code: - - Assert.Equal("Hello!", parameters.Single()); - - - - - - Creates a parameter capture using specified . - - The captured object type - - Arrange code: - - var capturedValue = string.Empty; - var match = new CaptureMatch{string}(x => capturedValue = x); - mock.Setup(x => x.DoSomething(Capture.With(match))); - - Assert code: - - Assert.Equal("Hello!", capturedValue); - - - - - - Allows creation custom matchers that can be used on setups to capture parameter values. - - - - - - Initializes an instance of the capture match. - - An action to run on captured value - - - - Initializes an instance of the capture match. - - An action to run on captured value - A predicate used to filter captured parameters - - - - Determines the way default values are generated - calculated for loose mocks. - - - - - Default behavior, which generates empty values for - value types (i.e. default(int)), empty array and - enumerables, and nulls for all other reference types. - - - - - Whenever the default value generated by - is null, replaces this value with a mock (if the type - can be mocked). - - - For sealed classes, a null value will be generated. - - - - - - All default value generation strategies other than or - are represented by this enumeration value. - - - Do not set (nor ) to this value. - If you want to set up a custom default value generation strategy, set - or instead. - - - - - - - - is the abstract base class for default value providers. - These are responsible for producing e. g. return values when mock methods or properties get invoked unexpectedly. - In other words, whenever there is no setup that would determine the return value for a particular invocation, - Moq asks the mock's default value provider to produce a return value. - - - - - Gets the corresponding to ; - that is, a default value provider returning "empty" values e. g. for collection types. - - - - - Gets the corresponding to ; - that is, a default value provider returning mocked objects or "empty" values for unmockable types. - - - - - Initializes a new instance of the class. - - - - - Gets the enumeration value that corresponds to this default value provider. - Must be overridden by Moq's internal providers that have their own corresponding . - - - - - Produces a default value of the specified type. - Must be overridden in derived classes. - - The of the requested default value. - The on which an unexpected invocation has occurred. - - Implementations may assume that all parameters have valid, non-, non- values. - - - - - - Produces a default argument value for the specified method parameter. - May be overridden in derived classes. - - - By default, this method will delegate to . - - - The describing the method parameter for which a default argument value should be produced. - The on which an unexpected invocation has occurred. - - Implementations may assume that all parameters have valid, non-, non- values. - - - - - - Produces a default return value for the specified method. - May be overridden in derived classes. - - - By default, this method will delegate to . - - - The describing the method for which a default return value should be produced. - The on which an unexpected invocation has occurred. - - Implementations may assume that all parameters have valid, non-, non- values. - - - - - A that returns an empty default value - for invocations that do not have setups or return values, with loose mocks. - This is the default behavior for a mock. - - - - - Provides partial evaluation of subtrees, whenever they can be evaluated locally. - - Matt Warren: http://blogs.msdn.com/mattwar - Documented by InSTEDD: http://www.instedd.org - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A function that decides whether a given expression - node can be part of the local function. - A new tree with sub-trees evaluated and replaced. - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A new tree with sub-trees evaluated and replaced. - - - - Evaluates and replaces sub-trees when first candidate is reached (top-down) - - - - - Performs bottom-up analysis to determine which nodes can possibly - be part of an evaluated sub-tree. - - - - - An compiles LINQ expression trees () to delegates. - Whenever Moq needs to compile an expression tree, it uses the instance set up by . - - - - - The default instance, which simply delegates to the framework's . - - - - - Gets or sets the instance that Moq uses to compile (LINQ expression trees). - Defaults to . - - - - - Initializes a new instance of the class. - - - - - Compiles the specified LINQ expression tree. - - The LINQ expression tree that should be compiled. - - - - Compiles the specified LINQ expression tree. - - The type of delegate to which the expression will be compiled. - The LINQ expression tree that should be compiled. - - - - Wraps this in a node if needed. - - The which should be wrapped. - The with which to make the compatible. - - LINQ expression trees generally enforce type compatibility rules that are stricter than - the assignment-compatibility used by e.g. . For - example, while is assignable-to , you - will need a conversion in a LINQ expression tree to model the value-type boxing operation. - - - - - Checks whether the given expression can be split by . - - - - - Splits an expression such as `m => m.A.B(x).C[y] = z` into a chain of parts - that can be set up one at a time: - - `m => m.A`, - `... => ....B(x)`, - `... => ....C`, - `... => ...[y] = z`. - - - The split points are chosen such that each part has exactly one associated - and optionally some argument expressions. - - - - It was not possible to completely split up the expression. - - - - - Converts the body of the lambda expression into the referenced by it. - - - - - Checks whether the body of the lambda expression is a property access. - - - - - Checks whether the body of the lambda expression is a indexer access. - - - - - TODO: remove this code when https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=331583 - is fixed. - - - - - Applies the specified to this expression tree. - - The to which should be applied. - The that should be applied to . - - - - A reconstructs LINQ expression trees () - from delegates. It is the counterpart to . - - - - - Reconstructs a from the given delegate. - - The delegate for which to reconstruct a LINQ expression tree. - Arguments to pass to a parameterized constructor of . (Optional.) - - - - Extracts the arguments from a lambda expression that calls a constructor. - - The constructor expression. - Extracted argument values. - - - - Evaluates variables that have been closed over by a lambda function. - - - - - Replaces nodes for property or indexer accessor methods - with equivalent nodes. - - - - In the case of getter accessors such as `x.get_Property()`, the result will be - a single node: `x.Property`. - - - In the case of setter accessors such as `x.set_Property(y)`, the result will be - a combination of and : - `x.Property = y`. - - - - - - - - Gets the default value for the specified type. This is the Reflection counterpart of C#'s operator. - - - - - Gets the least-derived in the given type that provides - the implementation for the given . - - - - - Gets whether the given is a delegate type. - - - - - Visits all constituent parts of , replacing all type matchers - that match the type argument at the corresponding position in . - - The type to be matched. May be, or contain, type matchers. - The type argument to match against . - - - - Ensures the given is not null. - Throws otherwise. - - - - - Ensures the given string is not null or empty. - Throws in the first case, or - in the latter. - - - - - Provides information about an invocation of a mock object. - - - - - Gets the method of the invocation. - - - - - Gets the arguments of the invocation. - - - - - Gets the setup that matched this invocation (or if there was no matching setup). - - - - - Gets whether this invocation was successfully verified by any of the various `Verify` methods. - - - - - The value being returned for a non-void method if no exception was thrown. - - - - - Optional exception if the method invocation results in an exception being thrown. - - - - - A list of invocations which have been performed on a mock. - - - - - Resets all invocations recorded for this mock. - - - - - Covariant interface for such that casts between IMock<Employee> to IMock<Person> - are possible. Only covers the covariant members of . - - - - - Exposes the mocked object instance. - - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called for mocked classes if no setup is matched. - Defaults to . - - - - - Specifies the behavior to use when returning default values for unexpected invocations on loose mocks. - - - - - Implemented by all generated mock object instances. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - Implemented by all generated mock object instances. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - This role interface represents a 's ability to intercept method invocations for its . - It is meant for use by . - - - - - Base class for mocks and static helper class with methods that apply to mocked objects, - such as to retrieve a from an object instance. - - - - - Creates a mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - Behavior of the mock. - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - The predicate with the specification of how the mocked object should behave. - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - The predicate with the specification of how the mocked object should behave. - Behavior of the mock. - The type of the mocked object. - The mocked object created. - - - - Initializes a new instance of the class. - - - - - Retrieves the mock object for the given object instance. - - The instance of the mocked object. - - Type of the mock to retrieve. - Can be omitted as it's inferred from the object instance passed in as the instance. - - The mock associated with the mocked object. - The received instance was not created by Moq. - - The following example shows how to add a new setup to an object instance - which is not the original but rather the object associated with it: - - // Typed instance, not the mock, is retrieved from some test API. - HttpContextBase context = GetMockContext(); - - // context.Request is the typed object from the "real" API - // so in order to add a setup to it, we need to get - // the mock that "owns" it - Mock<HttpRequestBase> request = Mock.Get(context.Request); - - request.Setup(req => req.AppRelativeCurrentExecutionFilePath) - .Returns(tempUrl); - - - - - - Verifies that all verifiable expectations have been met. - - Not all verifiable expectations were met. - - - - Verifies all expectations regardless of whether they have been flagged as verifiable. - - At least one expectation was not met. - - - - Gets the interfaces additionally implemented by the mock object. - - - This list may be modified by calls to up until the first call to . - - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called for mocked classes if no setup is matched. - Defaults to . - - - - - Specifies the behavior to use when returning default values for unexpected invocations on loose mocks. - - - - - Gets the mocked object instance. - - - - - Gets the interfaces directly inherited from the mocked type (). - - - - - Gets list of invocations which have been performed on this mock. - - - - - Returns the mocked object value. - - - - - Retrieves the type of the mocked object, its generic type argument. - This is used in the auto-mocking of hierarchy access. - - - - - Gets or sets the instance that will be used - e. g. to produce default return values for unexpected invocations. - - - - - The used to initialize automatically stubbed properties. - It is equal to the value of at the time when - was last called. - - - - - Gets the setups that have been configured on this mock, - in chronological order (that is, oldest setup first, most recent setup last). - - - - - A set of switches that influence how this mock will operate. - You can opt in or out of certain features via this property. - - - - - Verifies that all verifiable expectations have been met. - - Not all verifiable expectations were met. - - This example sets up an expectation and marks it as verifiable. - After the mock is used, a Verify() call is issued on the mock - to ensure the method in the setup was invoked: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)) - .Returns(true) - .Verifiable(); - - ... - - // Will throw if the test code did not call HasInventory. - this.Verify(); - - - - - - Verifies all expectations regardless of whether they have been flagged as verifiable. - - At least one expectation was not met. - - This example sets up an expectation without marking it as verifiable. - After the mock is used, a call is issued on the mock - to ensure that all expectations are met: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)) - .Returns(true); - - ... - - // Will throw if the test code did not call HasInventory, - // even though that expectation was not marked as verifiable. - mock.VerifyAll(); - - - - - - Adds an interface implementation to the mock, allowing setups to be specified for it. - - - This method can only be called before the first use of the mock property, - at which point the runtime type has already been generated and no more interfaces can be added to it. - - Also, must be an interface and not a class, - which must be specified when creating the mock instead. - - - Type of interface to cast the mock to. - The specified is not an interface. - - The mock type has already been generated by accessing the property. - - - - - Defines the default return value for all mocked methods or properties with return type . - - The return type for which to define a default value. - The default return value. - - Default return value is respected only when there is no matching setup for a method call. - - - - - Initializes a new instance of the class. - - The of the concrete proxy object on which a method is being invoked. - The method being invoked. - The arguments with which the specified is being invoked. - - - - Gets the method of the invocation. - - - - - Gets the arguments of the invocation. - - - Arguments may be modified. Derived classes must ensure that by-reference parameters are written back - when the invocation is ended by a call to any of the three Returns methods. - - - - - Calls the method implementation - and returns its return value (or for methods). - - - - - - - - Internal type to mark invocation results as "exception occurred during execution". The type just - wraps the Exception so a thrown exception can be distinguished from an - return value. - - - - - A delegate-like type for use with `setup.Callback` which instructs the `Callback` verb - to provide the callback with the current , instead of - with a list of arguments. - - This type is useful in scenarios involving generic type argument matchers (such as - ) as allows the discovery of both - arguments and type arguments. - - - - - - Initializes a new instance of the type. - - The delegate that should be wrapped by this instance. - - - - A delegate-like type for use with `setup.Returns` which instructs the `Returns` verb - to provide the callback with the current , instead of - with a list of arguments. - - This type is useful in scenarios involving generic type argument matchers (such as - ) as allows the discovery of both - arguments and type arguments. - - - - - - Initializes a new instance of the type. - - The delegate that should be wrapped by this instance. - - - - Describes the "shape" of an invocation against which concrete s can be matched. - - This shape is described by which has the general form - `mock => mock.Method(...arguments)`. Because the method and arguments are frequently needed, - they are cached in and - for faster access. - - - - - - A setup configured on a mock. - - - - - - The setup expression. - - - - - Gets the inner mock of this setup (if present and known). - - An "inner mock" is the instance associated with a setup's return value, - if that setup is configured to return a mock object. - - - This property will be if a setup either does not return a mock object, - or if Moq cannot safely determine its return value without risking any side effects. For instance, - Moq is able to inspect the return value if it is a constant (e.g. `.Returns(value)`); - if, on the other hand, it gets computed by a factory function (e.g. `.Returns(() => value)`), - Moq will not attempt to retrieve that value just to find the inner mock, - since calling a user-provided function could have effects beyond Moq's understanding and control. - - - - - - Gets whether this setup is conditional. - - - - - - Gets whether this setup was matched by at least one invocation on the mock. - - - - - Gets whether this setup has been overridden - (that is, whether it is being shadowed by a more recent non-conditional setup with an equal expression). - - - - - Gets whether this setup is "verifiable". - - - This property gets sets by the `.Verifiable()` setup verb. - - Note that setups can be verified even if this property is : - completely ignores this property. - , however, will only verify setups where this property is . - - - - - - Returns the instance to which this setup belongs. - - - - - Returns the original setup expression from which this setup resulted. - - For setups doing a simple member access or method invocation (such as `mock => mock.Member`), - this property will be equal to . - - - For setups whose expression involves member chaining (such as `parent => parent.Child.Member`), - Moq does not create a single setup, but one for each member access/invocation. - The example just given will result in two setups: - - a setup for `parent => parent.Child` on the parent mock; and - on its inner mock, a setup for `(child) => (child).Member`. - - These are the setups that will be put in the mocks' collections; - their will return the partial expression for just a single member access, - while their will return the original, full expression. - - - This property may also return if this setup was created automatically, - e.g. by or by . - - - - - - Verifies this setup and optionally all verifiable setups of its inner mock (if present and known). - - If is set to , - the semantics of this method are essentially the same as those of , - except that this setup (instead of a mock) is used as the starting point for verification, - and will always be verified itself (even if not flagged as verifiable). - - - - Specifies whether recursive verification should be performed. - - - Verification failed due to one or more unmatched setups. - - - - - - - Verifies this setup and all setups of its inner mock (if present and known), - regardless of whether they have been flagged as verifiable. - - The semantics of this method are essentially the same as those of , - except that this setup (instead of a mock) is used as the starting point for verification. - - - - Verification failed due to one or more unmatched setups. - - - - - - - A list of setups that have been configured on a mock, - in chronological order (that is, oldest setup first, most recent setup last). - - - - - Allows the specification of a matching condition for an argument in a method invocation, - rather than a specific argument value. "It" refers to the argument being matched. - - - This class allows the setup to match a method invocation with an arbitrary value, - with a value in a specified range, or even one that matches a given predicate. - - - - - Contains matchers for (C#) / (VB.NET) parameters of type . - - The parameter type. - - - - Matches any value that is assignment-compatible with type . - - - - - Matches any value of the given type. - - Type of the value. - - Typically used when the actual argument value for a method call is not relevant. - - - - // Throws an exception for a call to Remove with any string value. - mock.Setup(x => x.Remove(It.IsAny<string>())).Throws(new InvalidOperationException()); - - - - - - A type matcher that matches any generic type argument. - - If the generic type parameter is constrained to (C#) / - (VB.NET), use instead. - - - If the generic type parameter has more specific constraints, - you can define your own type matcher inheriting from the type to which the type parameter is constrained. - See and . - - - - - - Matches any value of the given type, except null. - - Type of the value. - - - - Matches any value that satisfies the given predicate. - - The predicate used to match the method argument. - Type of the argument to check. - - Allows the specification of a predicate to perform matching of method call arguments. - - - This example shows how to return the value 1 whenever the argument to - the Do method is an even number. - - mock.Setup(x => x.Do(It.Is<int>(i => i % 2 == 0))) - .Returns(1); - - - - This example shows how to throw an exception if the argument to the method - is a negative number: - - mock.Setup(x => x.GetUser(It.Is<int>(i => i < 0))) - .Throws(new ArgumentException()); - - - - - - Matches any value that satisfies the given predicate. - - Use this overload when you specify a type matcher for . - The callback you provide will then receive the actual parameter type - as well as the invocation argument. - - - The predicate used to match the method argument. - Type of the argument to check. - - Allows the specification of a predicate to perform matching of method call arguments. - - - - - Matches any value that equals the using the . - To use the default comparer for the specified object, specify the value inline, - i.e. mock.Verify(service => service.DoWork(value)). - - Use this overload when you specify a value and a comparer. - - - The value to match with. - An with which the values should be compared. - Type of the argument to check. - - - - Matches any value that is in the range specified. - - The lower bound of the range. - The upper bound of the range. - The kind of range. See . - Type of the argument to check. - - The following example shows how to expect a method call with an integer argument - within the 0..100 range. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - - The sequence of possible values. - Type of the argument to check. - - The following example shows how to expect a method call with an integer argument - with value from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(values))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - - The sequence of possible values. - An with which the values should be compared. - Type of the argument to check. - - - - Matches any value that is present in the sequence specified. - - The sequence of possible values. - Type of the argument to check. - - The following example shows how to expect a method call with an integer argument - with a value of 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(1, 2, 3))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - - The sequence of disallowed values. - Type of the argument to check. - - The following example shows how to expect a method call with an integer argument - with value not found from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(values))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - - The sequence of disallowed values. - An with which the values should be compared. - Type of the argument to check. - - - - Matches any value that is not found in the sequence specified. - - The sequence of disallowed values. - Type of the argument to check. - - The following example shows how to expect a method call with an integer argument - of any value except 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(1, 2, 3))) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - - The following example shows how to expect a call to a method where the string argument - matches the given regular expression: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+"))) - .Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - The options used to interpret the pattern. - - The following example shows how to expect a call to a method where the string argument - matches the given regular expression, in a case insensitive way: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+", RegexOptions.IgnoreCase))) - .Returns(1); - - - - - - A type matcher that matches subtypes of , as well as itself. - - The type whose subtypes should match. - - - - A type matcher that matches any value type. - - - - - Types that implement this interface represent a criterion against which generic type arguments are matched. - - To be used in combination with . - - - - - - Matches the provided type argument against the criterion represented by this type matcher. - - - The generic type argument that should be matched. - - - if the provided type argument matched the criterion represented by this instance; - otherwise, . - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Defines the Callback verb and overloads. - - - - - Specifies a callback to invoke when the method is called that receives the original . - - This overload is intended to be used in scenarios involving generic type argument matchers - (such as ). The callback will receive the current , - which allows discovery of both arguments and type arguments. - - - For all other use cases, you should prefer the other Callback overloads as they provide - better static type safety. - - - - - Figure out the generic type argument used for a mocked method call: - mock.Setup(m => m.DoSomethingWith<It.IsAnyType>(...)) - .Callback(new InvocationAction(invocation => - { - var typeArgument = invocation.Method.GetGenericArguments()[0]; - // do something interesting with the type argument - }); - mock.Object.DoSomethingWith<Something>(); - - - - - - Specifies a callback of any delegate type to invoke when the method is called. - This overload specifically allows you to define callbacks for methods with by-ref parameters. - By-ref parameters can be assigned to. - - The callback method to invoke. Must have return type void (C#) or be a Sub (VB.NET). - - Invokes the given callback with the concrete invocation argument value. You can modify - by-ref parameters inside the callback. - - delegate void ExecuteAction(ref Command command); - - Command c = ...; - mock.Setup(x => x.Execute(ref c)) - .Callback(new ExecuteAction((ref Command command) => Console.WriteLine("Executing command..."))); - - - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean - value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The argument type of the invoked method. - The callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback((string command) => Console.WriteLine(command)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Callback verb and overloads for callbacks on - setups that return a value. - - Mocked type. - Type of the return value of the setup. - - - - Specifies a callback to invoke when the method is called that receives the original . - - This overload is intended to be used in scenarios involving generic type argument matchers - (such as ). The callback will receive the current , - which allows discovery of both arguments and type arguments. - - - For all other use cases, you should prefer the other Callback overloads as they provide - better static type safety. - - - - Figure out the generic type argument used for a mocked method call: - - mock.Setup(m => m.DoSomethingWith<It.IsAnyType>(...)) - .Callback(new InvocationAction(invocation => - { - var typeArgument = invocation.Method.GetGenericArguments()[0]; - // do something interesting with the type argument - }); - mock.Object.DoSomethingWith<Something>(); - - - - - - Specifies a callback of any delegate type to invoke when the method is called. - This overload specifically allows you to define callbacks for methods with by-ref parameters. - By-ref parameters can be assigned to. - - The callback method to invoke. Must have return type void (C#) or be a Sub (VB.NET). - - Invokes the given callback with the concrete invocation argument value. You can modify - by-ref parameters inside the callback. - - delegate void ExecuteAction(ref Command command); - - Command c = ...; - mock.Setup(x => x.Execute(ref c)) - .Callback(new ExecuteAction((ref Command command) => Console.WriteLine("Executing command..."))); - - - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true) - .Returns(true); - - Note that in the case of value-returning methods, after the Callback - call you can still specify the return value. - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the argument of the invoked method. - Callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback(command => Console.WriteLine(command)) - .Returns(true); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15, arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Callback verb for property getter setups. - - - Mocked type. - Type of the property. - - - - Specifies a callback to invoke when the property is retrieved. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupGet(x => x.Suspended) - .Callback(() => called = true) - .Returns(true); - - - - - - Defines the Callback verb for property setter setups. - - Type of the property. - - - - Specifies a callback to invoke when the property is set that receives the - property value being set. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupSet(x => x.Suspended) - .Callback((bool state) => Console.WriteLine(state)); - - - - - - Defines the CallBase verb. - - - - - Calls the real method of the object. - - - - - Defines the Raises verb. - - - - - Specifies the event that will be raised - when the setup is met. - - An expression that represents an event attach or detach action. - The event arguments to pass for the raised event. - - The following example shows how to raise an event when - the setup is met: - - var mock = new Mock<IContainer>(); - - mock.Setup(add => add.Add(It.IsAny<string>(), It.IsAny<object>())) - .Raises(add => add.Added += null, EventArgs.Empty); - - - - - - Specifies the event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - A function that will build the - to pass when raising the event. - - - - - Specifies the custom event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - The arguments to pass to the custom delegate (non EventHandler-compatible). - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the ninth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - The type of the sixteenth argument received by the expected invocation. - - - - - Defines the Returns verb. - - Mocked type. - Type of the return value from the expression. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the method call: - - mock.Setup(x => x.Execute("ping")) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return from the method. - - This overload is intended to be used in scenarios involving generic type argument matchers, - such as . The function will receive the current , - which allows discovery of both arguments and type arguments. - - - For all other use cases, you should prefer the other Returns overloads as they provide - better static type safety. - - - - Mock a method to act like a generic factory method: - - factory.Setup(m => m.Create<It.IsAnyType>()) - .Returns(new InvocationFunc(invocation => - { - var typeArgument = invocation.Method.GetGenericArguments()[0]; - return Activator.CreateInstance(typeArgument); - }); - var something = factory.Object.Create<Something>(); - - - - - - Specifies a function that will calculate the value to return from the method. - This overload specifically allows you to specify a function with by-ref parameters. - Those by-ref parameters can be assigned to (though you should probably do that from - a Callback instead). - - The function that will calculate the return value. - - Return a calculated value when the method is called: - - delegate bool ExecuteFunc(ref Command command); - - Command c = ...; - mock.Setup(x => x.Execute(ref c)) - .Returns(new ExecuteFunc((ref Command command) => command.IsExecutable)); - - - - - - Specifies a function that will calculate the value to return from the method. - - The function that will calculate the return value. - - Return a calculated value when the method is called: - - mock.Setup(x => x.Execute("ping")) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the method - is executed and the value the returnValues array has at - that moment. - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the argument of the invoked method. - The function that will calculate the return value. - - Return a calculated value which is evaluated lazily at the time of the invocation. - - The lookup list can change between invocations and the setup - will return different values accordingly. Also, notice how the specific - string argument is retrieved by simply declaring it as part of the lambda - expression: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Returns((string command) => returnValues[command]); - - - - - - Calls the real method of the object and returns its return value. - - The value calculated by the real method of the object. - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2) => arg1 + arg2); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3) => arg1 + arg2 + arg3); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4) => arg1 + arg2 + arg3 + arg4); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5) => arg1 + arg2 + arg3 + arg4 + arg5); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the ninth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16); - - - - - - Defines the Returns verb for property get setups. - - Mocked type. - Type of the property. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the property getter call: - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return for the property. - - The function that will calculate the return value. - - Return a calculated value when the property is retrieved: - - mock.SetupGet(x => x.Suspended) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the property - is retrieved and the value the returnValues array has at - that moment. - - - - - Calls the real property of the object and returns its return value. - - The value calculated by the real property of the object. - - - - Implements the fluent API. - - - - - The expectation will be considered only in the former condition. - - - - - - - The expectation will be considered only in the former condition. - - - - - - - - Setups the get. - - The type of the property. - The expression. - - - - - Setups the set. - - The type of the property. - The setter expression. - - - - - Setups the set. - - The setter expression. - - - - - Defines the Pass and Throws verbs for sequence setups - on void methods. - - - - - Configures the next call in the sequence to do nothing. - - - The following code configures the first call to Execute() - to do nothing, and the second call to throw an exception. - - mock.SetupSequence(m => m.Execute()) - .Pass() - .Throws<InvalidOperationException>(); - - - - - - Configures the next call in the sequence to throw an exception. - - - The following code configures the first call to Execute() - to do nothing, and the second call to throw an exception. - - mock.SetupSequence(m => m.Execute()) - .Pass() - .Throws<InvalidOperationException>(); - - - - - - Configures the next call in the sequence to throw an exception. - - - The following code configures the first call to Execute() - to do nothing, and the second call to throw an exception. - - mock.SetupSequence(m => m.Execute()) - .Pass() - .Throws(new InvalidOperationException()); - - - - - - Language for ReturnSequence - - - - - Returns value - - - - - Uses delegate to get return value - - The function that will calculate the return value. - - - - Throws an exception - - - - - Throws an exception - - - - - Calls original method - - - - - Defines the Throws verb. - - - - - Specifies the exception to throw when the method is invoked. - - Exception instance to throw. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws(new ArgumentException()); - - - - - - Specifies the type of exception to throw when the method is invoked. - - Type of exception to instantiate and throw when the setup is matched. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws<ArgumentException>(); - - - - - - Defines the Verifiable verb. - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable(); - - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met, and specifies a message for failures. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable("Ping should be executed always!"); - - - - - - Defines occurrence members to constraint setups. - - - - - The expected invocation can happen at most once. - - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMostOnce(); - - - - - - The expected invocation can happen at most specified number of times. - - The number of times to accept calls. - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMost( 5 ); - - - - - - A default implementation of IQueryable for use with QueryProvider - - - - - Converts a taken-apart binary expression such as `m.A.B` (==) `x` to - `Mocks.SetupReturns(Mock.Get(m), m' => m'.A.B, (object)x)`. - - Body of the expression to set up. - Return value to be configured for . - - - - Locates the root mock object in a setup expression (which is usually, but not always, a ), - stores a reference to it, and finally replaces it with a new . - - - - - Utility repository class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the repository constructor) and later verifying each - mock can become repetitive and tedious. - - This repository class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overridden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var repository = new MockRepository(MockBehavior.Strict); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - repository.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the repository - to create loose mocks and later verify only verifiable setups: - - var repository = new MockRepository(MockBehavior.Loose); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // this setup will be verified when we verify the repository - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the repository - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - repository.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the repository with a - default strict behavior, overriding that default for a - specific mock: - - var repository = new MockRepository(MockBehavior.Strict); - - // this particular one we want loose - var foo = repository.Create<IFoo>(MockBehavior.Loose); - var bar = repository.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - repository.Verify(); - - - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - Behavior of the mocks. - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - Behavior of the mocks. - The type of the mocked object to query. - - - - Creates a mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - Behavior of the mock. - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - The predicate with the setup expressions. - Behavior of the mock. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queryable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Initializes the repository with the given - for newly created mocks from the repository. - - The behavior to use for mocks created - using the repository method if not overridden - by using the overload. - - - - Allows querying the universe of mocks for those that behave - according to the LINQ query specification. - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - Behavior of the mocks. - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - Behavior of the mocks. - The type of the mocked object to query. - - - - Creates a mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates a mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queryable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Abstract base class for default value providers that look up and delegate to value factory functions for the requested type(s). - If a request cannot be satisfied by any registered factory, the default value gets produced by a fallback strategy. - - - - Derived classes can register and deregister factory functions with and , - respectively. - - - The fallback value generation strategy is implemented by the overridable method. - - - This base class sets up factory functions for task types (, , - and ) that produce completed tasks containing default values. - If this behavior is not desired, derived classes may deregister those standard factory functions via . - - - - - - Initializes a new instance of the class. - - - - - Deregisters any factory function that might currently be registered for the given type(s). - Subsequent requests for values of the given type(s) will be handled by the fallback strategy. - - The type(s) for which to remove any registered factory function. - - - - Registers a factory function for the given type(s). - Subsequent requests for values of the given type(s) will be handled by the specified function. - - - - The type(s) for which to register the given function. - - - All array types are represented by (). - Generic types are represented by their open generic type definition, e. g. (<>). - - - The factory function responsible for producing values for the given type. - - - - - - - - - - - - - Determines the default value for the given when no suitable factory is registered for it. - May be overridden in derived classes. - - The type of which to produce a value. - The on which an unexpected invocation has occurred. - - - - Allows creating custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own - argument matching rules. - - - Argument matching is used to determine whether a concrete invocation in the mock - matches a given setup. This matching mechanism is fully extensible. - - - Creating a custom matcher is straightforward. You just need to create a method - that returns a value from a call to - with your matching condition and optional friendly render expression: - - public Order IsBigOrder() - { - return Match.Create<Order>( - o => o.GrandTotal >= 5000, - () => IsBigOrder()); // a friendly expression to render on failures - } - - This method can be used in any mock setup invocation: - - mock.Setup(m => m.Submit(IsBigOrder()) - .Throws<UnauthorizedAccessException>(); - - At runtime, Moq knows that the return value was a matcher and - evaluates your predicate with the actual value passed into your predicate. - - Another example might be a case where you want to match a lists of orders - that contains a particular one. You might create matcher like the following: - - - public static class Orders - { - public static IEnumerable<Order> Contains(Order order) - { - return Match.Create<IEnumerable<Order>>(orders => orders.Contains(order)); - } - } - - Now we can invoke this static method instead of an argument in an invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - - - - - Provided for the sole purpose of rendering the delegate passed to the - matcher constructor if no friendly render lambda is provided. - - - - - Initializes the matcher with the condition that will be checked - in order to match invocation values. - - The condition to match against actual values. - - - - Initializes the matcher with the condition that will be checked - in order to match invocation values. - - The condition to match against actual values. - - A lambda representation of the matcher, to be used when rendering error messages, - such as () => It.IsAny<string<(). - - - - - Initializes the matcher with the condition that will be checked in order to match invocation values. - - The predicate of this overload will not only be provided with a - method argument, but also with the associated parameter's type. This parameter type essentially - overrides in cases where the latter is a type matcher. Therefore, - use this method overload if you want your custom matcher to work together with type matchers. - - - - The condition to match against actual values. - - This function will be passed the invocation argument, as well as the type of the associated parameter. - - - - A lambda representation of the matcher. - - - - - Allows creating custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own - argument matching rules. - - Type of the value to match. - - - - - - - - - - - - - A per-thread observer that records invocations to matchers for later inspection. - - - - This component requires the active cooperation of the respective subsystem. - That is, invoked matchers call into if an - observer is active on the current thread. - - - - - - Returns the current timestamp. The next call will return a timestamp greater than this one, - allowing you to order invocations and matcher observations. - - - - - Adds the specified as an observation. - - - - - Checks whether at least one observation is available, - and if so, returns the last one. - - The observed matcher observed last. - - - - Matcher to treat static functions as matchers. - - mock.Setup(x => x.StringMethod(A.MagicString())); - - public static class A - { - [Matcher] - public static string MagicString() { return null; } - public static bool MagicString(string arg) - { - return arg == "magic"; - } - } - - Will succeed if: mock.Object.StringMethod("magic"); - and fail with any other call. - - - - - Options to customize the behavior of the mock. - - - - - Causes the mock to always throw - an exception for invocations that don't have a - corresponding setup. - - - - - Will never throw exceptions, returning default - values when necessary (null for reference types, - zero for value types or empty enumerables and arrays). - - - - - Default mock behavior, which equals . - - - - - A that returns an empty default value - for non-mockable types, and mocks for all other types (interfaces and - non-sealed classes) that can be mocked. - - - - - Exception thrown by mocks when they are not properly set up, - when setups are not matched, when verification fails, etc. - - - A distinct exception type is provided so that exceptions - thrown by a mock can be distinguished from other exceptions - that might be thrown in tests. - - Moq does not provide a richer hierarchy of exception types, as - tests typically should not catch or expect exceptions - from mocks. These are typically the result of changes - in the tested class or its collaborators' implementation, and - result in fixes in the mock setup so that they disappear and - allow the test to pass. - - - - - - Returns the exception to be thrown when a setup limited by is matched more often than once. - - - - - Returns the exception to be thrown when a setup limited by is matched more often than the specified maximum number of times. - - - - - Returns the exception to be thrown when finds no invocations (or the wrong number of invocations) that match the specified expectation. - - - - - Returns the exception to be thrown when a strict mock has no setup corresponding to the specified invocation. - - - - - Returns the exception to be thrown when a strict mock has no setup that provides a return value for the specified invocation. - - - - - Returns the exception to be thrown when a setup was not matched. - - - - - Returns an exception whose message is the concatenation of the given ' messages - and whose reason(s) is the combination of the given ' reason(s). - Used by when it finds one or more mocks with verification errors. - - - - - Returns the exception to be thrown when finds invocations that have not been verified. - - - - - Indicates whether this exception is a verification fault raised by Verify() - - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Provides additional methods on mocks. - - - - - Resets this mock's state. This includes its setups, configured default return values, registered event handlers, and all recorded invocations. - - The mock whose state should be reset. - - - - Resets all invocations recorded for this mock. - - The mock whose recorded invocations should be reset. - - - - Helper class to setup a full trace between many mocks - - - - - Initialize a trace setup - - - - - Allow sequence to be repeated - - - - - Contains extension methods that are related to . - - - - - Perform an expectation in the trace. - - - - - Provides a mock implementation of . - - Type to mock, which can be an interface, a class, or a delegate. - - Any interface type can be used for mocking, but for classes, only abstract and virtual members can be mocked. - - The behavior of the mock with regards to the setups and the actual calls is determined by the optional - that can be passed to the constructor. - - - - The following example shows establishing setups with specific values for method invocations: - - // Arrange - var order = new Order(TALISKER, 50); - var warehouse = new Mock<IWarehouse>(); - warehouse.Setup(w => w.HasInventory(TALISKER, 50)).Returns(true); - - // Act - order.Fill(warehouse.Object); - - // Assert - Assert.True(order.IsFilled); - - - - The following example shows how to use the class - to specify conditions for arguments instead of specific values: - - // Arrange - var order = new Order(TALISKER, 50); - var warehouse = new Mock<IWarehouse>(); - - // shows how to expect a value within a range: - warehouse.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - // shows how to throw for unexpected calls. - warehouse.Setup(x => x.Remove( - It.IsAny<string>(), - It.IsAny<int>())) - .Throws(new InvalidOperationException()); - - // Act - order.Fill(warehouse.Object); - - // Assert - Assert.False(order.IsFilled); - - - - - - Ctor invoked by AsTInterface exclusively. - - - - - Initializes an instance of the mock with behavior. - - - - var mock = new Mock<IFormatProvider>(); - - - - - - Initializes an instance of the mock with behavior - and with the given constructor arguments for the class. (Only valid when is a class.) - - Optional constructor arguments if the mocked type is a class. - - The mock will try to find the best match constructor given the constructor arguments, - and invoke that to initialize the instance.This applies only for classes, not interfaces. - - - - var mock = new Mock<MyProvider>(someArgument, 25); - - - - - - Initializes an instance of the mock with the specified behavior. - - Behavior of the mock. - - - var mock = new Mock<IFormatProvider>(MockBehavior.Strict); - - - - - - Initializes an instance of the mock with a specific behavior - and with the given constructor arguments for the class. - - Behavior of the mock. - Optional constructor arguments if the mocked type is a class. - - The mock will try to find the best match constructor given the constructor arguments, - and invoke that to initialize the instance. This applies only to classes, not interfaces. - - - - - Initializes an instance of the mock using the given constructor call including its - argument values and with a specific behavior. - - Lambda expression that creates an instance of . - Behavior of the mock. - - var mock = new Mock<MyProvider>(() => new MyProvider(someArgument, 25), MockBehavior.Loose); - - - - - - - - - - - Gets or sets the instance that will be used - e. g. to produce default return values for unexpected invocations. - - - - - Exposes the mocked object instance. - - - - - Allows naming of your mocks, so they can be easily identified in error messages (e.g. from failed assertions). - - - - - Returns the name of the mock. - - - - - Returns the mocked object value. - - - - - A set of switches that influence how this mock will operate. - You can opt in or out of certain features via this property. - - - - - Adds an interface implementation to the mock, allowing setups to be specified for it. - - - This method can only be called before the first use of the mock property, - at which point the runtime type has already been generated and no more interfaces can be added to it. - - Also, must be an interface and not a class, - which must be specified when creating the mock instead. - - - Type of interface to cast the mock to. - The specified is not an interface. - - The mock type has already been generated by accessing the property. - - - The following example creates a mock for the main interface - and later adds to it to verify it's called by the consumer code: - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - // add IDisposable interface - var disposable = mock.As<IDisposable>(); - disposable.Setup(d => d.Dispose()) - .Verifiable(); - - - - - - Specifies a setup on the mocked type for a call to a method. - - Lambda expression that specifies the expected method invocation. - - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - - - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - - - - - Specifies a setup on the mocked type for a call to a non- (value-returning) method. - - Lambda expression that specifies the method invocation. - Type of the return value. Typically omitted as it can be inferred from the expression. - - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - - - - mock.Setup(x => x.HasInventory("Talisker", 50)) - .Returns(true); - - - - - - Specifies a setup on the mocked type for a call to a property getter. - - Lambda expression that specifies the property getter. - Type of the property. Typically omitted as it can be inferred from the expression. - - If more than one setup is set for the same property getter, - the latest one wins and is the one that will be executed. - - - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a setup on the mocked type for a call to a property setter. - - The Lambda expression that sets a property to a value. - Type of the property. Typically omitted as it can be inferred from the expression. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - This overloads allows the use of a callback already typed for the property type. - - - - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies a setup on the mocked type for a call to a property setter. - - Lambda expression that sets a property to a value. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies a setup on the mocked type for a call to an event add. - - Lambda expression that adds an event. - - If more than one setup is set for the same event add, - the latest one wins and is the one that will be executed. - - - - mock.SetupAdd(x => x.EventHandler += (s, e) => {}); - - - - - - Specifies a setup on the mocked type for a call to an event remove. - - Lambda expression that removes an event. - - If more than one setup is set for the same event remove, - the latest one wins and is the one that will be executed. - - - - mock.SetupRemove(x => x.EventHandler -= (s, e) => {}); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and later returned when the property is requested. - (This is also known as "stubbing".) - - Property expression to stub. - - Type of the property, inferred from the property expression (does not need to be specified). - - - If you have an interface with an int property Value, - you might stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.SetupProperty(v => v.Value); - - After the SetupProperty call has been issued, setting and retrieving - the object value will behave as expected: - - IHaveValue v = mock.Object; - v.Value = 5; - Assert.Equal(5, v.Value); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and later returned when the property is requested. - This overload allows setting the initial value for the property. - (This is also known as "stubbing".) - - Property expression to stub. - Initial value for the property. - - Type of the property, inferred from the property expression (does not need to be specified). - - - If you have an interface with an int property Value, - you might stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.SetupProperty(v => v.Value, 5); - - After the SetupProperty call has been issued, setting and retrieving the object value - will behave as expected: - - IHaveValue v = mock.Object; - Assert.Equal(5, v.Value); // Initial value was stored - - // New value set which changes the initial value - v.Value = 6; - Assert.Equal(6, v.Value); - - - - - - Specifies that the all properties on the mock should have "property behavior", - meaning that setting their value will cause them to be saved and later returned when the properties is requested. - (This is also known as "stubbing".) - The default value for each property will be the one generated as specified by the - property for the mock. - - - If the mock's is set to , - the mocked default values will also get all properties setup recursively. - - - - - Return a sequence of values, once per call. - - - - - Performs a sequence of actions, one per call. - - - - - Allows setting up a conditional setup. - Conditional setups are only matched by an invocation - when the specified condition evaluates to - at the time when the invocation occurs. - - - The condition that should be checked - when a setup is being matched against an invocation. - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given invocation with specific parameters was performed: - - var mock = new Mock<IProcessor>(); - - ... // exercise mock - - // Will throw if the test code didn't call Execute with a "ping" string argument. - mock.Verify(proc => proc.Execute("ping")); - - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. - Use in conjunction with the default . - - Expression to verify. - Message to show if verification fails. - The invocation was not performed on the mock. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - Type of return value from the expression. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given invocation with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50)); - - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - Type of return value from the expression. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Expression to verify. - The number of times a method is expected to be called. - Type of return value from the expression. - - The invocation was not called the number of times specified by . - - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. - - Expression to verify. - Message to show if verification fails. - Type of return value from the expression. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given invocation with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50), - "When filling orders, inventory has to be checked"); - - - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. - - Expression to verify. - The number of times a method is expected to be called. - Message to show if verification fails. - Type of return value from the expression. - - The invocation was not called the number times specified by . - - - - - Verifies that a property was read on the mock. - - Expression to verify. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given property was retrieved from it: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't retrieve the IsClosed property. - mock.VerifyGet(warehouse => warehouse.IsClosed); - - - - - - Verifies that a property was read on the mock. - - The number of times a method is expected to be called. - Expression to verify. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - - The invocation was not called the number times specified by . - - - - - Verifies that a property was read on the mock. - - The number of times a method is expected to be called. - Expression to verify. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - - The invocation was not called the number times specified by . - - - - - Verifies that a property was read on the mock, specifying a failure error message. - - Expression to verify. - Message to show if verification fails. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - The invocation was not performed on the mock. - - - - Verifies that a property was read on the mock, specifying a failure error message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - - The invocation was not called the number times specified by . - - - - - Verifies that a property was read on the mock, specifying a failure error message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - Type of the property to verify. Typically omitted as it can be inferred from the expression's return type. - - - The invocation was not called the number times specified by . - - - - - Verifies that a property was set on the mock. - - Expression to verify. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given property was set on it: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true); - - - - - - Verifies that a property was set on the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that a property was set on the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that a property was set on the mock, specifying a failure message. - - Expression to verify. - Message to show if verification fails. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given property was set on it: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true, - "Warehouse should always be closed after the action"); - - - - - - Verifies that a property was set on the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that a property was set on the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was added to the mock. - - Expression to verify. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given event handler was subscribed to an event: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't subscribe to the OnClosed event. - mock.VerifyAdd(warehouse => warehouse.OnClosed += It.IsAny<EventHandler>()); - - - - - - Verifies that an event was added to the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was added to the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was added to the mock, specifying a failure message. - - Expression to verify. - Message to show if verification fails. - The invocation was not performed on the mock. - - - - Verifies that an event was added to the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was added to the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was removed from the mock. - - Expression to verify. - The invocation was not performed on the mock. - - This example assumes that the mock has been used, and later we want to verify - that a given event handler was removed from an event: - - var mock = new Mock<IWarehouse>(); - - ... // exercise mock - - // Will throw if the test code didn't unsubscribe from the OnClosed event. - mock.VerifyRemove(warehouse => warehouse.OnClose -= It.IsAny<EventHandler>()); - - - - - - Verifies that an event was removed from the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was removed from the mock. - - The number of times a method is expected to be called. - Expression to verify. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was removed from the mock, specifying a failure message. - - Expression to verify. - Message to show if verification fails. - The invocation was not performed on the mock. - - - - Verifies that an event was removed from the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that an event was removed from the mock, specifying a failure message. - - The number of times a method is expected to be called. - Expression to verify. - Message to show if verification fails. - - The invocation was not called the number of times specified by . - - - - - Verifies that there were no calls other than those already verified. - - There was at least one invocation not previously verified. - - - - Raises the event referenced in using the given argument. - - - The argument is invalid for the target event invocation, - or the is not an event attach or detach expression. - - - The following example shows how to raise a - event: - - var mock = new Mock<IViewModel>(); - mock.Raise(x => x.PropertyChanged -= null, new PropertyChangedEventArgs("Name")); - - - - This example shows how to invoke an event with a custom event arguments class - in a view that will cause its corresponding presenter to react by changing its state: - - var mockView = new Mock<IOrdersView>(); - var presenter = new OrdersPresenter(mockView.Object); - - // Check that the presenter has no selection by default - Assert.Null(presenter.SelectedOrder); - - // Raise the event with a specific arguments data - mockView.Raise(v => v.SelectionChanged += null, new OrderEventArgs { Order = new Order("moq", 500) }); - - // Now the presenter reacted to the event, and we have a selected order - Assert.NotNull(presenter.SelectedOrder); - Assert.Equal("moq", presenter.SelectedOrder.ProductName); - - - - - - Raises the event referenced in using the given argument for a non--typed event. - - - The arguments are invalid for the target event invocation, - or the is not an event attach or detach expression. - - - The following example shows how to raise a custom event that does not adhere - to the standard EventHandler: - - var mock = new Mock<IViewModel>(); - mock.Raise(x => x.MyEvent -= null, "Name", bool, 25); - - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Marks a method as a matcher, which allows complete replacement - of the built-in class with your own argument - matching rules. - - - - This feature has been deprecated in favor of the new - and simpler . - - - - The argument matching is used to determine whether a concrete - invocation in the mock matches a given setup. This - matching mechanism is fully extensible. - - - There are two parts of a matcher: the compiler matcher - and the runtime matcher. - - - Compiler matcher - Used to satisfy the compiler requirements for the - argument. Needs to be a method optionally receiving any arguments - you might need for the matching, but with a return type that - matches that of the argument. - - Let's say I want to match a lists of orders that contains - a particular one. I might create a compiler matcher like the following: - - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - } - - Now we can invoke this static method instead of an argument in an - invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - Note that the return value from the compiler matcher is irrelevant. - This method will never be called, and is just used to satisfy the - compiler and to signal Moq that this is not a method that we want - to be invoked at runtime. - - - - Runtime matcher - - The runtime matcher is the one that will actually perform evaluation - when the test is run, and is defined by convention to have the - same signature as the compiler matcher, but where the return - value is the first argument to the call, which contains the - object received by the actual invocation at runtime: - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - - At runtime, the mocked method will be invoked with a specific - list of orders. This value will be passed to this runtime - matcher as the first argument, while the second argument is the - one specified in the setup (x.Save(Orders.Contains(order))). - - The boolean returned determines whether the given argument has been - matched. If all arguments to the expected method are matched, then - the setup matches and is evaluated. - - - - - - Using this extensible infrastructure, you can easily replace the entire - set of matchers with your own. You can also avoid the - typical (and annoying) lengthy expressions that result when you have - multiple arguments that use generics. - - - The following is the complete example explained above: - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - } - - And the concrete test using this matcher: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - // use mock, invoke Save, and have the matcher filter. - - - - - - Contains obsolete API members as extension methods so that existing code continues to compile, - but new code doesn't see them. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Utility factory class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the factory constructor) and later verifying each - mock can become repetitive and tedious. - - This factory class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overridden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - factory.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the factory - to create loose mocks and later verify only verifiable setups: - - var factory = new MockFactory(MockBehavior.Loose); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // this setup will be verified when we verify the factory - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the factory - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - factory.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the factory with a - default strict behavior, overriding that default for a - specific mock: - - var factory = new MockFactory(MockBehavior.Strict); - - // this particular one we want loose - var foo = factory.Create<IFoo>(MockBehavior.Loose); - var bar = factory.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - factory.Verify(); - - - - - - - Initializes the factory with the given - for newly created mocks from the factory. - - The behavior to use for mocks created - using the factory method if not overridden - by using the overload. - - - - Gets the default of mocks created by this repository. - - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Gets or sets the instance that will be used - e. g. to produce default return values for unexpected invocations. - - - - - Gets the mocks that have been created by this factory and - that will get verified together. - - - - - A set of switches that influence how mocks created by this factory will operate. - You can opt in or out of certain features via this property. - - - - - Creates a new mock with the default - specified at factory construction time. - - Type to mock. - A new . - - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - // use mock on tests - - factory.VerifyAll(); - - - - - - Creates a new mock with the default - specified at factory construction time and with the - the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Constructor arguments for mocked classes. - A new . - - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>("Foo", 25, true); - // use mock on tests - - factory.Verify(); - - - - - - Creates a new mock with the given . - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory: - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(MockBehavior.Loose); - - - - - - Creates a new mock with the given - and with the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - Constructor arguments for mocked classes. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory, passing - constructor arguments: - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>(MockBehavior.Strict, "Foo", 25, true); - - - - - - Creates an instance of the mock using the given constructor call including its - argument values and with a specific behavior. - - Type to mock. - Lambda expression that creates an instance of . - Behavior of the mock. - A new . - - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyClass>(() => new MyClass("Foo", 25, true), MockBehavior.Loose); - // use mock on tests - - factory.Verify(); - - - - - - Implements creation of a new mock within the factory. - - Type to mock. - The behavior for the new mock. - Optional arguments for the construction of the mock. - - - - Verifies all verifiable setups on all mocks created by this factory. - - - One or more mocks had setups that were not satisfied. - - - - Verifies all setups on all mocks created by this factory. - - - One or more mocks had setups that were not satisfied. - - - - Calls on all mocks created by this factory. - - - One or more mocks had invocations that were not verified. - - - - Invokes for each mock - in , and accumulates the resulting - verification exceptions that might be - thrown from the action. - - The action to execute against - each mock. - - - - Provides additional methods on mocks. - - - Provided as extension methods as they confuse the compiler - with the overloads taking Action. - - - - - Specifies a setup on the mocked type for a call to - to a property setter, regardless of its value. - - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - Type of the property. Typically omitted as it can be inferred from the expression. - Type of the mock. - The target mock for the setup. - Lambda expression that specifies the property setter. - - - mock.SetupSet(x => x.Suspended); - - - - This method is not legacy, but must be on an extension method to avoid - confusing the compiler with the new Action syntax. - - - - - Verifies that a property has been set on the mock, regardless of its value. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - Message to show if verification fails. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times, and specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Message to show if verification fails. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Helper for sequencing return values in the same method. - - - - - Return a sequence of values, once per call. - - - - - Performs a sequence of actions, one per call. - - - - - Return a sequence of tasks, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Throws a sequence of exceptions, once per call. - - - - - Throws a sequence of exceptions, once per call. - - - - - Throws a sequence of exceptions, once per call. - - - - - Throws a sequence of exceptions, once per call. - - - - - Allocation-free adapter type for treating a `ParameterInfo[]` array like a `Type[]` array. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Mock type has already been initialized by accessing its Object property. Adding interfaces must be done before that.. - - - - - Looks up a localized string similar to Value cannot be an empty string.. - - - - - Looks up a localized string similar to Matcher '{0}' is unmatchable: An implicit conversion operator will convert arguments of type '{1}' to the parameter's type '{2}', which is assignment-incompatible.. - - - - - Looks up a localized string similar to Can only add interfaces to the mock.. - - - - - Looks up a localized string similar to CallBase cannot be used with Delegate mocks.. - - - - - Looks up a localized string similar to Can't set return value for void method {0}.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for delegate mocks.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for interface mocks.. - - - - - Looks up a localized string similar to A matching constructor for the given arguments was not found on the mocked type.. - - - - - Looks up a localized string similar to Delays have to be greater than zero to ensure an async callback is used.. - - - - - Looks up a localized string similar to Expression {0} involves a field access, which is not supported. Use properties instead.. - - - - - Looks up a localized string similar to Invalid callback. This overload of the "Callback" method only accepts "void" (C#) or "Sub" (VB.NET) delegates with parameter types matching those of the set up method.. - - - - - Looks up a localized string similar to Invalid callback. Setup on method with {0} parameter(s) cannot invoke callback with different number of parameters ({1}).. - - - - - Looks up a localized string similar to Invalid callback. Setup on method with parameters ({0}) cannot invoke callback with parameters ({1}).. - - - - - Looks up a localized string similar to Invalid callback. Setup on method with return type '{0}' cannot invoke callback with return type '{1}'.. - - - - - Looks up a localized string similar to Cannot retrieve a mock with the given object type {0} as it's not the main type of the mock or any of its additional interfaces. - Please cast the argument to one of the supported types: {1}. - Remember that there's no generics covariance in the CLR, so your object must be one of these types in order for the call to succeed.. - - - - - Looks up a localized string similar to Invalid callback. This overload of the "Returns" method only accepts non-"void" (C#) or "Function" (VB.NET) delegates with parameter types matching those of the set up method.. - - - - - Looks up a localized string similar to The return type of the last member shown above is not mockable.. - - - - - Looks up a localized string similar to The equals ("==" or "=" in VB) and the conditional 'and' ("&&" or "AndAlso" in VB) operators are the only ones supported in the query specification expression. Unsupported expression: {0}. - - - - - Looks up a localized string similar to LINQ method '{0}' not supported.. - - - - - Looks up a localized string similar to Expression contains a call to a method which is not virtual (overridable in VB) or abstract. Unsupported expression: {0}. - - - - - Looks up a localized string similar to Could not determine the correct positions for all argument matchers ({0} in total) used in a call to this method: {1}. - This could be caused by an unrecognized type conversion, coercion, narrowing, or widening, and is most likely a bug in Moq. Please report your use case to the Moq team.. - - - - - Looks up a localized string similar to Member {0}.{1} does not exist.. - - - - - Looks up a localized string similar to Method {0}.{1} is public. Use strong-typed Expect overload instead: - mock.Setup(x => x.{1}()); - . - - - - - Looks up a localized string similar to No protected method {0}.{1} found whose signature is compatible with the provided arguments ({2}).. - - - - - Looks up a localized string similar to Cannot set up {0}.{1} because it is not accessible to the proxy generator used by Moq: - {2}. - - - - - Looks up a localized string similar to Minimum delay has to be lower than maximum delay.. - - - - - Looks up a localized string similar to {0} invocation failed with mock behavior {1}. - {2}. - - - - - Looks up a localized string similar to The next member after the last one shown above is non-virtual, sealed, or not visible to the proxy factory.. - - - - - Looks up a localized string similar to No constructor call could be found.. - - - - - Looks up a localized string similar to No invocations performed.. - - - - - Looks up a localized string similar to Expected invocation on the mock at least {0} times, but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock at least once, but was never performed: . - - - - - Looks up a localized string similar to Expected invocation on the mock at most {1} times, but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock at most once, but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock between {0} and {1} times (Exclusive), but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock between {0} and {1} times (Inclusive), but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock exactly {0} times, but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock should never have been performed, but was {2} times: . - - - - - Looks up a localized string similar to Expected invocation on the mock once, but was {2} times: . - - - - - Looks up a localized string similar to All invocations on the mock must have a corresponding setup.. - - - - - Looks up a localized string similar to Object instance was not created by Moq.. - - - - - Looks up a localized string similar to Out expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Performed invocations:. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a getter.. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a setter.. - - - - - Looks up a localized string similar to Type {0} does not have matching protected member: {1}. - - - - - Looks up a localized string similar to Ref expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Invocation needs to return a value and therefore must have a corresponding setup that provides it.. - - - - - Looks up a localized string similar to Expression is not an event add: {0}. - - - - - Looks up a localized string similar to Expression is not an event remove: {0}. - - - - - Looks up a localized string similar to Expression is not a property access: {0}. - - - - - Looks up a localized string similar to Expression is not a setter: {0}. - - - - - Looks up a localized string similar to Type {0} does not have a default (public parameterless) constructor.. - - - - - Looks up a localized string similar to Type {0} does not implement required interface {1}. - - - - - Looks up a localized string similar to Type to mock ({0}) must be an interface, a delegate, or a non-sealed, non-static class.. - - - - - Looks up a localized string similar to To specify a setup for public property {0}.{1}, use the typed overloads, such as: - mock.Setup(x => x.{1}).Returns(value); - mock.SetupGet(x => x.{1}).Returns(value); //equivalent to previous one - mock.SetupSet(x => x.{1}).Callback(callbackDelegate); - . - - - - - Looks up a localized string similar to Unexpected translation of a member access: {0}. - - - - - Looks up a localized string similar to Unhandled binding type: {0}. - - - - - Looks up a localized string similar to Unhandled expression type: {0}. - - - - - Looks up a localized string similar to {0}: - This setup was not matched.. - - - - - Looks up a localized string similar to Unsupported expression: {0}. - - - - - Looks up a localized string similar to Unsupported expression: {0} - {1}. - - - - - Looks up a localized string similar to Extension methods (here: {0}) may not be used in setup / verification expressions.. - - - - - Looks up a localized string similar to Member {0} is not supported for protected mocking.. - - - - - Looks up a localized string similar to Non-overridable members (here: {0}) may not be used in setup / verification expressions.. - - - - - Looks up a localized string similar to Static members (here: {0}) may not be used in setup / verification expressions.. - - - - - Looks up a localized string similar to {0}: - This mock failed verification due to the following unverified invocations:. - - - - - Looks up a localized string similar to Use ItExpr.IsNull<TValue> rather than a null argument value, as it prevents proper method lookup.. - - - - - Looks up a localized string similar to It is impossible to call the provided strongly-typed predicate due to the use of a type matcher. Provide a weakly-typed predicate with two parameters (object, Type) instead.. - - - - - Looks up a localized string similar to {0}:. - - - - - Looks up a localized string similar to {0}: - This mock failed verification due to the following:. - - - - - Looks up a localized string similar to The mock repository failed verification due to the following:. - - - - - Allows setups to be specified for protected members (methods and properties) - seen through another type with corresponding members (that is, members - having identical signatures as the ones to be set up). - - Type of the mocked object. - - Any type with members whose signatures are identical to the mock's protected members (except for their accessibility level). - - - - - Specifies a setup on the mocked type for a call to a method. - - Lambda expression that specifies the expected method invocation. - - - - - Specifies a setup on the mocked type for a call to a value-returning method. - - Type of the return value. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the expected method invocation. - - - - - Specifies a setup on the mocked type for a call to a property getter. - - Type of the property. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the property getter. - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and later returned when the property is requested. - (This is also known as "stubbing".) - - Type of the property. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the property. - Initial value for the property. - - - - Return a sequence of values, once per call. - - Type of the return value. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the expected method invocation. - - - - Performs a sequence of actions, one per call. - - Lambda expression that specifies the expected method invocation. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Lambda expression that specifies the method invocation. - - Number of times that the invocation is expected to have occurred. - If omitted, assumed to be . - - Message to include in the thrown if verification fails. - The specified invocation did not occur (or did not occur the specified number of times). - - - - Verifies that a specific invocation matching the given expression was performed on the mock. - Use in conjunction with the default . - - Type of the return value. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the method invocation. - - Number of times that the invocation is expected to have occurred. - If omitted, assumed to be . - - Message to include in the thrown if verification fails. - The specified invocation did not occur (or did not occur the specified number of times). - - - - Verifies that a property was read on the mock. - - Type of the property. Typically omitted as it can be inferred from the expression. - Lambda expression that specifies the method invocation. - - Number of times that the invocation is expected to have occurred. - If omitted, assumed to be . - - Message to include in the thrown if verification fails. - The specified invocation did not occur (or did not occur the specified number of times). - - - - Allows setups to be specified for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Set up protected members (methods and properties) seen through another type with identical member signatures. - - - Any type with members whose signatures are identical to the mock's protected members (except for their accessibility level). - - - - - Specifies a setup for a void method invocation with the given - , optionally specifying arguments for the method call. - - The name of the void method to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a setup for a void method invocation with the given - , optionally specifying arguments for the method call. - - The name of the void method to be invoked. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a setup for a void method invocation with the given - , optionally specifying arguments for the method call. - - The name of the void method to be invoked. - An array of types to be substituted for the type parameters of the current generic method definition. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a setup for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The return type of the method or property. - - - - Specifies a setup for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - Should the parameter types match exactly types that were provided - The return type of the method or property. - - - - Specifies a setup for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The name of the method or property to be invoked. - An array of types to be substituted for the type parameters of the current generic method definition. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - Should the parameter types match exactly types that were provided - The return type of the method or property. - - - - Specifies a setup for an invocation on a property getter with the given - . - - The name of the property. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The name of the property. - The property value. If argument matchers are used, - remember to use rather than . - The type of the property. - - - - Performs a sequence of actions, one per call. - - Name of the method or property being set up. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Performs a sequence of actions, one per call. - - Name of the method or property being set up. - Determines whether the parameter types should exactly match the types provided. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Performs a sequence of actions, one per call. - - Name of the method or property being set up. - An array of types to be substituted for the type parameters of the current generic method definition. - Determines whether the parameter types should exactly match the types provided. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Return a sequence of values, once per call. - - Name of the method or property being set up. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - Return type of the method or property being set up. - - - - Return a sequence of values, once per call. - - Name of the method or property being set up. - Determines whether the parameter types should exactly match the types provided. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - Return type of the method or property being set up. - - - - Return a sequence of values, once per call. - - Name of the method or property being set up. - An array of types to be substituted for the type parameters of the current generic method definition. - Determines whether the parameter types should exactly match the types provided. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - Return type of the method or property being set up. - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - The number of times a method is allowed to be called. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - An array of types to be substituted for the type parameters of the current generic method definition. - The number of times a method is allowed to be called. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - The number of times a method is allowed to be called. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - An array of types to be substituted for the type parameters of the current generic method definition. - The number of times a method is allowed to be called. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - An array of types to be substituted for the type parameters of the current generic method definition. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - An array of types to be substituted for the type parameters of the current generic method definition. - Should the parameter types match exactly types that were provided - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property getter with the given - . - The invocation was not call the times specified by - . - - The name of the property. - The number of times a method is allowed to be called. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The invocation was not call the times specified by - . - The name of the property. - The number of times a method is allowed to be called. - The property value. - The type of the property. If argument matchers are used, - remember to use rather than . - - - - Allows the specification of a matching condition for an - argument in a protected member setup, rather than a specific - argument value. "ItExpr" refers to the argument being matched. - - - Use this variant of argument matching instead of - for protected setups. - This class allows the setup to match a method invocation - with an arbitrary value, with a value in a specified range, or - even one that matches a given predicate, or null. - - - - - Contains matchers for (C#) / (VB.NET) parameters of type . - - The parameter type. - - - - Matches any value that is assignment-compatible with type . - - - - - - Matches a null value of the given type. - - - Required for protected mocks as the null value cannot be used - directly as it prevents proper method overload selection. - - - - // Throws an exception for a call to Remove with a null string value. - mock.Protected() - .Setup("Remove", ItExpr.IsNull<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value of the given type. - - - Typically used when the actual argument value for a method - call is not relevant. - - - - // Throws an exception for a call to Remove with any string value. - mock.Protected() - .Setup("Remove", ItExpr.IsAny<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value that satisfies the given predicate. - - Type of the argument to check. - The predicate used to match the method argument. - - Allows the specification of a predicate to perform matching - of method call arguments. - - - This example shows how to return the value 1 whenever the argument to the - Do method is an even number. - - mock.Protected() - .Setup("Do", ItExpr.Is<int>(i => i % 2 == 0)) - .Returns(1); - - This example shows how to throw an exception if the argument to the - method is a negative number: - - mock.Protected() - .Setup("GetUser", ItExpr.Is<int>(i => i < 0)) - .Throws(new ArgumentException()); - - - - - - Matches any value that is in the range specified. - - Type of the argument to check. - The lower bound of the range. - The upper bound of the range. - The kind of range. See . - - The following example shows how to expect a method call - with an integer argument within the 0..100 range. - - mock.Protected() - .Setup("HasInventory", - ItExpr.IsAny<string>(), - ItExpr.IsInRange(0, 100, Range.Inclusive)) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+")) - .Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - The options used to interpret the pattern. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression, in a case insensitive way: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+", RegexOptions.IgnoreCase)) - .Returns(1); - - - - - - used to replace occurrences of `TAnalog.Member` sub-expressions with `T.Member`. - - - - - Enables the Protected() method on , - allowing setups to be set for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Enable protected setups for the mock. - - Mocked object type. Typically omitted as it can be inferred from the mock instance. - The mock to set the protected setups on. - - - - An implementation of that is based on Castle DynamicProxy. - - - - - - - - This hook tells Castle DynamicProxy to proxy the default methods it suggests, - plus some of the methods defined by , e.g. so we can intercept - and give mocks useful default names. - - - - Do not use. (Moq requires this class so that methods can be set up on interface mocks.) - - - - - - - - - - - - Do not use. (Moq requires this interface so that methods can be set up on interface mocks.) - - - - - - - Gets the global instance used by Moq. - - - - - Kind of range to use in a filter specified through - . - - - - - The range includes the to and - from values. - - - - - The range does not include the to and - from values. - - - - - Defines async extension methods on IReturns. - - - - - Specifies the value to return from an asynchronous method. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The value to return, or . - - - - Specifies the value to return from an asynchronous method. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The value to return, or . - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies the exception to throw when the asynchronous method is invoked. - - Mocked type. - Returns verb which represents the mocked type and the task return type - Exception instance to throw. - - - - Specifies the exception to throw when the asynchronous method is invoked. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - Exception instance to throw. - - - - Specifies the exception to throw when the asynchronous method is invoked. - - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - Exception instance to throw. - - - - Allows to specify the delayed return value of an asynchronous method. - - - - - Allows to specify the delayed return value of an asynchronous method. - - - - - Allows to specify the delayed return value of an asynchronous method. - - - - - Allows to specify the delayed return value of an asynchronous method. - - - - - Allows to specify the delayed return value of an asynchronous method. - Use the argument to pass in (seeded) random generators used across your unit test. - - - - - Allows to specify the delayed return value of an asynchronous method. - Use the argument to pass in (seeded) random generators used across your unit test. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - Use the argument to pass in (seeded) random generators used across your unit test. - - - - - Allows to specify the exception thrown by an asynchronous method. - Use the argument to pass in (seeded) random generators used across your unit test. - - - - - Defines async extension methods on IReturns. - - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Type of the function parameter. - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Type of the function parameter. - Mocked type. - Type of the return value. - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Specifies a function that will calculate the value to return from the asynchronous method. - - Returns verb which represents the mocked type and the task of return type - The function that will calculate the return value. - - - - Programmable setup used by . - - - - - Attempts to get this setup's return value without invoking user code - (which could have side effects beyond Moq's understanding and control). - - - - - Verifies this setup and those of its inner mock (if present and known). - - - Specifies whether recursive verification should be performed. - - - Specifies which setups should be verified. - - - The set of mocks that have already been verified. - - - This setup or any of its inner mock (if present and known) failed verification. - - - - - Setup used by for property getters. - - - - - Setup used by for property setters. - - - - - Represents a switch, or a combination of switches, that can be either enabled or disabled. - When set via or , they determine how a mock will operate. - - - - - The default set of switches. The switches covered by this enumeration value may change between different versions of Moq. - - - - - When enabled, specifies that source file information should be collected for each setup. - This results in more helpful error messages, but may affect performance. - - - - - Defines the number of invocations allowed by a mocked method. - - - - Deconstructs this instance. - This output parameter will receive the minimum required number of calls satisfying this instance (i.e. the lower inclusive bound). - This output parameter will receive the maximum allowed number of calls satisfying this instance (i.e. the upper inclusive bound). - - - - Specifies that a mocked method should be invoked times - as minimum. - - The minimum number of times. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as minimum. - - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked times - as maximum. - - The maximum number of times. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as maximum. - - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked between - and times. - - The minimum number of times. - The maximum number of times. - The kind of range. See . - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly - times. - - The times that a method or property can be called. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should not be invoked. - - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly one time. - - An object defining the allowed number of invocations. - - - - Returns a value indicating whether this instance is equal to a specified value. - - A value to compare to this instance. - - if has the same value as this instance; - otherwise, . - - - - - Returns a value indicating whether this instance is equal to a specified value. - - An object to compare to this instance. - - if has the same value as this instance; - otherwise, . - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms - and data structures like a hash table. - - - - - Determines whether two specified objects have the same value. - - The first . - The second . - - if has the same value as ; - otherwise, . - - - - - Determines whether two specified objects have different values. - - The first . - The second . - - if the value of is different from - 's; otherwise, . - - - - - - - - Checks whether the specified number of invocations matches the constraint described by this instance. - - The number of invocations to check. - - if matches the constraint described by this instance; - otherwise, . - - - - - Marks a type as a type matcher, optionally specifying another type that will perform the matching. - - Type matchers preferably implement themselves. Use the parameterized form of this attribute - where this is not possible, such as when the type matcher needs to be a or - type in order to satisfy generic type constraints of the method where it is used. - - - - - - Initializes a new instance of the class. - - Use this constructor overload if the type on which this attribute is placed implements itself. - - - - - - Initializes a new instance of the class. - - Use this constructor overload if the type on which this attribute is placed does not implement . - The specified type will instead provide the implementation of . - - - The of a type that implements . - - - - Interface that is used to build fluent interfaces by hiding methods declared by from IntelliSense. - - - Code that consumes implementations of this interface should expect one of two things: - - When referencing the interface from within the same solution (project reference), you will still see the methods this interface is meant to hide. - When referencing the interface through the compiled output assembly (external reference), the standard Object methods will be hidden as intended. - When using Resharper, be sure to configure it to respect the attribute: Options, go to Environment | IntelliSense | Completion Appearance and check "Filter members by [EditorBrowsable] attribute". - - See https://kzu.github.io/IFluentInterface for more information. - - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Contains the two extension methods - and - . - - - - - Appends a string representation of the specified type to this instance. - - The instance to which to append. - The of which a string representation should be appended. - Any combination of formatting options that should be applied. (Optional.) - A reference to this instance after the append operation has completed. - - - - Gets a string representation of this instance. - - The of which a string representation is requested. - Any combination of formatting options that should be applied. (Optional.) - A string representation of this instance. - - - - Replacement for - which may be slow or even unavailable on earlier target frameworks. - - - - - Allows uniform reflection across all target frameworks. - - - - - Allows uniform reflection across all target frameworks. - - - - - Allows uniform reflection across all target frameworks. - - - - - Allows uniform reflection across all target frameworks. - - - - - An enumeration of available options when a name's string representation is requested. - - - - - The default type name formatting options. - - - - - Specifies that a type's namespace should be included. - - For example, the type is formatted as "Action" by default. - When this flag is specified, it will be formatted as "System.Action". - - - - - - Specifies that anonymous types should not be transformed to C#-like syntax. - - For example, the anonymous type of "new { Name = "Blob", Count = 17 }" is formatted as - "{string Name, int Count}" by default. When this flag is specified, it will be formatted as - the raw "display class" name, which looks something like "<>f__AnonymousType5<string, int>". - - - - - - Specifies that an open generic type's parameter names should be omitted. - - For example, the open generic type is formatted as "IEquatable<T>" by default. - When this flag is specified, it will be formatted as "IEquatable<>". - - - - - - Specifies that primitive types should not be mapped to their corresponding C# language keywords. - - For example, the type is formatted as "int" by default. - When this flag is specified, it will be formatted as "Int32". - - - - - - Specifies that nullable types should not be simplified to C# question mark syntax. - - For example, the type of is formatted as "int?" by default. - When this flag is specified, it will be formatted as "Nullable<int>". - - - - - - Specifies that value tuple types should not be transformed to C# tuple syntax. - - For example, the type of , - is formatted as "(bool, int)" by default. When this flag is specified, - it will be formatted as "ValueTuple<bool, int>". - - - - - diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml.meta deleted file mode 100644 index b3536f12..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/Moq.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: ae2bfa7f83c3fa345b6f4d9b61a827f7 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta deleted file mode 100644 index 47448b9a..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta +++ /dev/null @@ -1,96 +0,0 @@ -fileFormatVersion: 2 -guid: 5ef9269f2a2b1904d873cef51ab104a9 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: - - '!UNITY_SERVER' - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 1 - Exclude LinuxUniversal: 1 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 1 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - CPU: AnyCPU - DefaultValueInitialized: true - OS: AnyOS - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: LinuxUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: x86 - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml deleted file mode 100644 index 6a7cfcff..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - System.Runtime.CompilerServices.Unsafe - - - - Contains generic, low-level functionality for manipulating pointers. - - - Adds an element offset to the given reference. - The reference to add the offset to. - The offset to add. - The type of reference. - A new reference that reflects the addition of offset to pointer. - - - Adds an element offset to the given reference. - The reference to add the offset to. - The offset to add. - The type of reference. - A new reference that reflects the addition of offset to pointer. - - - Adds a byte offset to the given reference. - The reference to add the offset to. - The offset to add. - The type of reference. - A new reference that reflects the addition of byte offset to pointer. - - - Determines whether the specified references point to the same location. - The first reference to compare. - The second reference to compare. - The type of reference. - true if left and right point to the same location; otherwise, false. - - - Casts the given object to the specified type. - The object to cast. - The type which the object will be cast to. - The original object, casted to the given type. - - - Reinterprets the given reference as a reference to a value of type TTo. - The reference to reinterpret. - The type of reference to reinterpret.. - The desired type of the reference. - A reference to a value of type TTo. - - - Returns a pointer to the given by-ref parameter. - The object whose pointer is obtained. - The type of object. - A pointer to the given value. - - - Reinterprets the given location as a reference to a value of type T. - The location of the value to reference. - The type of the interpreted location. - A reference to a value of type T. - - - Determines the byte offset from origin to target from the given references. - The reference to origin. - The reference to target. - The type of reference. - Byte offset from origin to target i.e. target - origin. - - - Copies a value of type T to the given location. - The location to copy to. - A reference to the value to copy. - The type of value to copy. - - - Copies a value of type T to the given location. - The location to copy to. - A pointer to the value to copy. - The type of value to copy. - - - Copies bytes from the source address to the destination address. - The destination address to copy to. - The source address to copy from. - The number of bytes to copy. - - - Copies bytes from the source address to the destination address. - The destination address to copy to. - The source address to copy from. - The number of bytes to copy. - - - Copies bytes from the source address to the destination address -without assuming architecture dependent alignment of the addresses. - The destination address to copy to. - The source address to copy from. - The number of bytes to copy. - - - Copies bytes from the source address to the destination address -without assuming architecture dependent alignment of the addresses. - The destination address to copy to. - The source address to copy from. - The number of bytes to copy. - - - Initializes a block of memory at the given location with a given initial value. - The address of the start of the memory block to initialize. - The value to initialize the block to. - The number of bytes to initialize. - - - Initializes a block of memory at the given location with a given initial value. - The address of the start of the memory block to initialize. - The value to initialize the block to. - The number of bytes to initialize. - - - Initializes a block of memory at the given location with a given initial value -without assuming architecture dependent alignment of the address. - The address of the start of the memory block to initialize. - The value to initialize the block to. - The number of bytes to initialize. - - - Initializes a block of memory at the given location with a given initial value -without assuming architecture dependent alignment of the address. - The address of the start of the memory block to initialize. - The value to initialize the block to. - The number of bytes to initialize. - - - Reads a value of type T from the given location. - The location to read from. - The type to read. - An object of type T read from the given location. - - - Reads a value of type T from the given location -without assuming architecture dependent alignment of the addresses. - The location to read from. - The type to read. - An object of type T read from the given location. - - - Reads a value of type T from the given location -without assuming architecture dependent alignment of the addresses. - The location to read from. - The type to read. - An object of type T read from the given location. - - - Returns the size of an object of the given type parameter. - The type of object whose size is retrieved. - The size of an object of type T. - - - Subtracts an element offset from the given reference. - The reference to subtract the offset from. - The offset to subtract. - The type of reference. - A new reference that reflects the subraction of offset from pointer. - - - Subtracts an element offset from the given reference. - The reference to subtract the offset from. - The offset to subtract. - The type of reference. - A new reference that reflects the subraction of offset from pointer. - - - Subtracts a byte offset from the given reference. - The reference to subtract the offset from. - - The type of reference. - A new reference that reflects the subraction of byte offset from pointer. - - - Writes a value of type T to the given location. - The location to write to. - The value to write. - The type of value to write. - - - Writes a value of type T to the given location -without assuming architecture dependent alignment of the addresses. - The location to write to. - The value to write. - The type of value to write. - - - Writes a value of type T to the given location -without assuming architecture dependent alignment of the addresses. - The location to write to. - The value to write. - The type of value to write. - - - \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta deleted file mode 100644 index 5beccef3..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: bd302c62373af234aa3b85f183a9139b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.dll.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.dll.meta deleted file mode 100644 index f727c9b9..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.dll.meta +++ /dev/null @@ -1,93 +0,0 @@ -fileFormatVersion: 2 -guid: 4d8eefe1634e9f64c8b56699cf123837 -PluginImporter: - externalObjects: {} - serializedVersion: 2 - iconMap: {} - executionOrder: {} - defineConstraints: [] - isPreloaded: 0 - isOverridable: 0 - isExplicitlyReferenced: 1 - validateReferences: 1 - platformData: - - first: - '': Any - second: - enabled: 0 - settings: - Exclude Editor: 0 - Exclude Linux: 1 - Exclude Linux64: 1 - Exclude LinuxUniversal: 1 - Exclude OSXUniversal: 1 - Exclude Win: 1 - Exclude Win64: 1 - - first: - Any: - second: - enabled: 0 - settings: {} - - first: - Editor: Editor - second: - enabled: 1 - settings: - DefaultValueInitialized: true - - first: - Facebook: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Facebook: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Linux64 - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: LinuxUniversal - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: OSXUniversal - second: - enabled: 0 - settings: - CPU: x86 - - first: - Standalone: Win - second: - enabled: 0 - settings: - CPU: None - - first: - Standalone: Win64 - second: - enabled: 0 - settings: - CPU: None - - first: - Windows Store Apps: WindowsStoreApps - second: - enabled: 0 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml deleted file mode 100644 index 5e02a99d..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - System.Threading.Tasks.Extensions - - - - - - - - - - - - - - - - - - - Provides a value type that wraps a and a TResult, only one of which is used. - The result. - - - Initializes a new instance of the class using the supplied task that represents the operation. - The task. - The task argument is null. - - - Initializes a new instance of the class using the supplied result of a successful operation. - The result. - - - Retrieves a object that represents this . - The object that is wrapped in this if one exists, or a new object that represents the result. - - - Configures an awaiter for this value. - true to attempt to marshal the continuation back to the captured context; otherwise, false. - The configured awaiter. - - - Creates a method builder for use with an async method. - The created builder. - - - Determines whether the specified object is equal to the current object. - The object to compare with the current object. - true if the specified object is equal to the current object; otherwise, false. - - - Determines whether the specified object is equal to the current object. - The object to compare with the current object. - true if the specified object is equal to the current object; otherwise, false. - - - Creates an awaiter for this value. - The awaiter. - - - Returns the hash code for this instance. - The hash code for the current object. - - - Gets a value that indicates whether this object represents a canceled operation. - true if this object represents a canceled operation; otherwise, false. - - - Gets a value that indicates whether this object represents a completed operation. - true if this object represents a completed operation; otherwise, false. - - - Gets a value that indicates whether this object represents a successfully completed operation. - true if this object represents a successfully completed operation; otherwise, false. - - - Gets a value that indicates whether this object represents a failed operation. - true if this object represents a failed operation; otherwise, false. - - - Compares two values for equality. - The first value to compare. - The second value to compare. - true if the two values are equal; otherwise, false. - - - Determines whether two values are unequal. - The first value to compare. - The seconed value to compare. - true if the two values are not equal; otherwise, false. - - - Gets the result. - The result. - - - Returns a string that represents the current object. - A string that represents the current object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml.meta b/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml.meta deleted file mode 100644 index ae524839..00000000 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins/System.Threading.Tasks.Extensions.xml.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: d10dfee35e66dfc42bc69f1982619ff5 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/GameLift-Unity/ProjectSettings/AudioManager.asset b/GameLift-Unity/ProjectSettings/AudioManager.asset deleted file mode 100644 index 4f31e744..00000000 --- a/GameLift-Unity/ProjectSettings/AudioManager.asset +++ /dev/null @@ -1,17 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!11 &1 -AudioManager: - m_ObjectHideFlags: 0 - m_Volume: 1 - Rolloff Scale: 1 - Doppler Factor: 1 - Default Speaker Mode: 2 - m_SampleRate: 0 - m_DSPBufferSize: 1024 - m_VirtualVoiceCount: 512 - m_RealVoiceCount: 32 - m_SpatializerPlugin: - m_AmbisonicDecoderPlugin: - m_DisableAudio: 0 - m_VirtualizeEffects: 1 diff --git a/GameLift-Unity/ProjectSettings/ClusterInputManager.asset b/GameLift-Unity/ProjectSettings/ClusterInputManager.asset deleted file mode 100644 index e7886b26..00000000 --- a/GameLift-Unity/ProjectSettings/ClusterInputManager.asset +++ /dev/null @@ -1,6 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!236 &1 -ClusterInputManager: - m_ObjectHideFlags: 0 - m_Inputs: [] diff --git a/GameLift-Unity/ProjectSettings/DynamicsManager.asset b/GameLift-Unity/ProjectSettings/DynamicsManager.asset deleted file mode 100644 index b3c263d3..00000000 --- a/GameLift-Unity/ProjectSettings/DynamicsManager.asset +++ /dev/null @@ -1,30 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!55 &1 -PhysicsManager: - m_ObjectHideFlags: 0 - serializedVersion: 8 - m_Gravity: {x: 0, y: -9.81, z: 0} - m_DefaultMaterial: {fileID: 0} - m_BounceThreshold: 2 - m_SleepThreshold: 0.005 - m_DefaultContactOffset: 0.01 - m_DefaultSolverIterations: 6 - m_DefaultSolverVelocityIterations: 1 - m_QueriesHitBackfaces: 0 - m_QueriesHitTriggers: 1 - m_EnableAdaptiveForce: 0 - m_ClothInterCollisionDistance: 0 - m_ClothInterCollisionStiffness: 0 - m_ContactsGeneration: 1 - m_LayerCollisionMatrix: ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff - m_AutoSimulation: 1 - m_AutoSyncTransforms: 0 - m_ReuseCollisionCallbacks: 1 - m_ClothInterCollisionSettingsToggle: 0 - m_ContactPairsMode: 0 - m_BroadphaseType: 0 - m_WorldBounds: - m_Center: {x: 0, y: 0, z: 0} - m_Extent: {x: 250, y: 250, z: 250} - m_WorldSubdivisions: 8 diff --git a/GameLift-Unity/ProjectSettings/EditorBuildSettings.asset b/GameLift-Unity/ProjectSettings/EditorBuildSettings.asset deleted file mode 100644 index 0147887e..00000000 --- a/GameLift-Unity/ProjectSettings/EditorBuildSettings.asset +++ /dev/null @@ -1,8 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!1045 &1 -EditorBuildSettings: - m_ObjectHideFlags: 0 - serializedVersion: 2 - m_Scenes: [] - m_configObjects: {} diff --git a/GameLift-Unity/ProjectSettings/EditorSettings.asset b/GameLift-Unity/ProjectSettings/EditorSettings.asset deleted file mode 100644 index 817943ff..00000000 --- a/GameLift-Unity/ProjectSettings/EditorSettings.asset +++ /dev/null @@ -1,23 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!159 &1 -EditorSettings: - m_ObjectHideFlags: 0 - serializedVersion: 7 - m_ExternalVersionControlSupport: Visible Meta Files - m_SerializationMode: 2 - m_LineEndingsForNewScripts: 2 - m_DefaultBehaviorMode: 0 - m_PrefabRegularEnvironment: {fileID: 0} - m_PrefabUIEnvironment: {fileID: 0} - m_SpritePackerMode: 0 - m_SpritePackerPaddingPower: 1 - m_EtcTextureCompressorBehavior: 1 - m_EtcTextureFastCompressor: 1 - m_EtcTextureNormalCompressor: 2 - m_EtcTextureBestCompressor: 4 - m_ProjectGenerationIncludedExtensions: txt;xml;fnt;cd - m_ProjectGenerationRootNamespace: - m_CollabEditorSettings: - inProgressEnabled: 1 - m_EnableTextureStreamingInPlayMode: 1 diff --git a/GameLift-Unity/ProjectSettings/GraphicsSettings.asset b/GameLift-Unity/ProjectSettings/GraphicsSettings.asset deleted file mode 100644 index cd1c3d65..00000000 --- a/GameLift-Unity/ProjectSettings/GraphicsSettings.asset +++ /dev/null @@ -1,62 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!30 &1 -GraphicsSettings: - m_ObjectHideFlags: 0 - serializedVersion: 12 - m_Deferred: - m_Mode: 1 - m_Shader: {fileID: 69, guid: 0000000000000000f000000000000000, type: 0} - m_DeferredReflections: - m_Mode: 1 - m_Shader: {fileID: 74, guid: 0000000000000000f000000000000000, type: 0} - m_ScreenSpaceShadows: - m_Mode: 1 - m_Shader: {fileID: 64, guid: 0000000000000000f000000000000000, type: 0} - m_LegacyDeferred: - m_Mode: 1 - m_Shader: {fileID: 63, guid: 0000000000000000f000000000000000, type: 0} - m_DepthNormals: - m_Mode: 1 - m_Shader: {fileID: 62, guid: 0000000000000000f000000000000000, type: 0} - m_MotionVectors: - m_Mode: 1 - m_Shader: {fileID: 75, guid: 0000000000000000f000000000000000, type: 0} - m_LightHalo: - m_Mode: 1 - m_Shader: {fileID: 105, guid: 0000000000000000f000000000000000, type: 0} - m_LensFlare: - m_Mode: 1 - m_Shader: {fileID: 102, guid: 0000000000000000f000000000000000, type: 0} - m_AlwaysIncludedShaders: - - {fileID: 7, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15104, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15105, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 15106, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10753, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10770, guid: 0000000000000000f000000000000000, type: 0} - - {fileID: 10783, guid: 0000000000000000f000000000000000, type: 0} - m_PreloadedShaders: [] - m_SpritesDefaultMaterial: {fileID: 10754, guid: 0000000000000000f000000000000000, - type: 0} - m_CustomRenderPipeline: {fileID: 0} - m_TransparencySortMode: 0 - m_TransparencySortAxis: {x: 0, y: 0, z: 1} - m_DefaultRenderingPath: 1 - m_DefaultMobileRenderingPath: 1 - m_TierSettings: [] - m_LightmapStripping: 0 - m_FogStripping: 0 - m_InstancingStripping: 0 - m_LightmapKeepPlain: 1 - m_LightmapKeepDirCombined: 1 - m_LightmapKeepDynamicPlain: 1 - m_LightmapKeepDynamicDirCombined: 1 - m_LightmapKeepShadowMask: 1 - m_LightmapKeepSubtractive: 1 - m_FogKeepLinear: 1 - m_FogKeepExp: 1 - m_FogKeepExp2: 1 - m_AlbedoSwatchInfos: [] - m_LightsUseLinearIntensity: 0 - m_LightsUseColorTemperature: 0 diff --git a/GameLift-Unity/ProjectSettings/InputManager.asset b/GameLift-Unity/ProjectSettings/InputManager.asset deleted file mode 100644 index 17c8f538..00000000 --- a/GameLift-Unity/ProjectSettings/InputManager.asset +++ /dev/null @@ -1,295 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!13 &1 -InputManager: - m_ObjectHideFlags: 0 - serializedVersion: 2 - m_Axes: - - serializedVersion: 3 - m_Name: Horizontal - descriptiveName: - descriptiveNegativeName: - negativeButton: left - positiveButton: right - altNegativeButton: a - altPositiveButton: d - gravity: 3 - dead: 0.001 - sensitivity: 3 - snap: 1 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Vertical - descriptiveName: - descriptiveNegativeName: - negativeButton: down - positiveButton: up - altNegativeButton: s - altPositiveButton: w - gravity: 3 - dead: 0.001 - sensitivity: 3 - snap: 1 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire1 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left ctrl - altNegativeButton: - altPositiveButton: mouse 0 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire2 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left alt - altNegativeButton: - altPositiveButton: mouse 1 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire3 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: left shift - altNegativeButton: - altPositiveButton: mouse 2 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Jump - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: space - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse X - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse Y - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 1 - joyNum: 0 - - serializedVersion: 3 - m_Name: Mouse ScrollWheel - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0 - sensitivity: 0.1 - snap: 0 - invert: 0 - type: 1 - axis: 2 - joyNum: 0 - - serializedVersion: 3 - m_Name: Horizontal - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0.19 - sensitivity: 1 - snap: 0 - invert: 0 - type: 2 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Vertical - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: - altNegativeButton: - altPositiveButton: - gravity: 0 - dead: 0.19 - sensitivity: 1 - snap: 0 - invert: 1 - type: 2 - axis: 1 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire1 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 0 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire2 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 1 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Fire3 - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 2 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Jump - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: joystick button 3 - altNegativeButton: - altPositiveButton: - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Submit - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: return - altNegativeButton: - altPositiveButton: joystick button 0 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Submit - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: enter - altNegativeButton: - altPositiveButton: space - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 - - serializedVersion: 3 - m_Name: Cancel - descriptiveName: - descriptiveNegativeName: - negativeButton: - positiveButton: escape - altNegativeButton: - altPositiveButton: joystick button 1 - gravity: 1000 - dead: 0.001 - sensitivity: 1000 - snap: 0 - invert: 0 - type: 0 - axis: 0 - joyNum: 0 diff --git a/GameLift-Unity/ProjectSettings/NavMeshAreas.asset b/GameLift-Unity/ProjectSettings/NavMeshAreas.asset deleted file mode 100644 index 3b0b7c3d..00000000 --- a/GameLift-Unity/ProjectSettings/NavMeshAreas.asset +++ /dev/null @@ -1,91 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!126 &1 -NavMeshProjectSettings: - m_ObjectHideFlags: 0 - serializedVersion: 2 - areas: - - name: Walkable - cost: 1 - - name: Not Walkable - cost: 1 - - name: Jump - cost: 2 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - - name: - cost: 1 - m_LastAgentTypeID: -887442657 - m_Settings: - - serializedVersion: 2 - agentTypeID: 0 - agentRadius: 0.5 - agentHeight: 2 - agentSlope: 45 - agentClimb: 0.75 - ledgeDropHeight: 0 - maxJumpAcrossDistance: 0 - minRegionArea: 2 - manualCellSize: 0 - cellSize: 0.16666667 - manualTileSize: 0 - tileSize: 256 - accuratePlacement: 0 - debug: - m_Flags: 0 - m_SettingNames: - - Humanoid diff --git a/GameLift-Unity/ProjectSettings/NetworkManager.asset b/GameLift-Unity/ProjectSettings/NetworkManager.asset deleted file mode 100644 index 5dc6a831..00000000 --- a/GameLift-Unity/ProjectSettings/NetworkManager.asset +++ /dev/null @@ -1,8 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!149 &1 -NetworkManager: - m_ObjectHideFlags: 0 - m_DebugLevel: 0 - m_Sendrate: 15 - m_AssetToPrefab: {} diff --git a/GameLift-Unity/ProjectSettings/Physics2DSettings.asset b/GameLift-Unity/ProjectSettings/Physics2DSettings.asset deleted file mode 100644 index 57760e2e..00000000 --- a/GameLift-Unity/ProjectSettings/Physics2DSettings.asset +++ /dev/null @@ -1,38 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!19 &1 -Physics2DSettings: - m_ObjectHideFlags: 0 - serializedVersion: 4 - m_Gravity: {x: 0, y: -9.81} - m_DefaultMaterial: {fileID: 0} - m_VelocityIterations: 8 - m_PositionIterations: 3 - m_VelocityThreshold: 1 - m_MaxLinearCorrection: 0.2 - m_MaxAngularCorrection: 8 - m_MaxTranslationSpeed: 100 - m_MaxRotationSpeed: 360 - m_BaumgarteScale: 0.2 - m_BaumgarteTimeOfImpactScale: 0.75 - m_TimeToSleep: 0.5 - m_LinearSleepTolerance: 0.01 - m_AngularSleepTolerance: 2 - m_DefaultContactOffset: 0.01 - m_AutoSimulation: 1 - m_QueriesHitTriggers: 1 - m_QueriesStartInColliders: 1 - m_ChangeStopsCallbacks: 0 - m_CallbacksOnDisable: 1 - m_ReuseCollisionCallbacks: 1 - m_AutoSyncTransforms: 0 - m_AlwaysShowColliders: 0 - m_ShowColliderSleep: 1 - m_ShowColliderContacts: 0 - m_ShowColliderAABB: 0 - m_ContactArrowScale: 0.2 - m_ColliderAwakeColor: {r: 0.5686275, g: 0.95686275, b: 0.54509807, a: 0.7529412} - m_ColliderAsleepColor: {r: 0.5686275, g: 0.95686275, b: 0.54509807, a: 0.36078432} - m_ColliderContactColor: {r: 1, g: 0, b: 1, a: 0.6862745} - m_ColliderAABBColor: {r: 1, g: 1, b: 0, a: 0.2509804} - m_LayerCollisionMatrix: ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff diff --git a/GameLift-Unity/ProjectSettings/PresetManager.asset b/GameLift-Unity/ProjectSettings/PresetManager.asset deleted file mode 100644 index 820e662d..00000000 --- a/GameLift-Unity/ProjectSettings/PresetManager.asset +++ /dev/null @@ -1,27 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!1386491679 &1 -PresetManager: - m_ObjectHideFlags: 0 - m_DefaultList: - - type: - m_NativeTypeID: 108 - m_ManagedTypePPtr: {fileID: 0} - m_ManagedTypeFallback: - defaultPresets: - - m_Preset: {fileID: 2655988077585873504, guid: c1cf8506f04ef2c4a88b64b6c4202eea, - type: 2} - - type: - m_NativeTypeID: 1020 - m_ManagedTypePPtr: {fileID: 0} - m_ManagedTypeFallback: - defaultPresets: - - m_Preset: {fileID: 2655988077585873504, guid: 0cd792cc87e492d43b4e95b205fc5cc6, - type: 2} - - type: - m_NativeTypeID: 1006 - m_ManagedTypePPtr: {fileID: 0} - m_ManagedTypeFallback: - defaultPresets: - - m_Preset: {fileID: 2655988077585873504, guid: 7a99f8aa944efe94cb9bd74562b7d5f9, - type: 2} diff --git a/GameLift-Unity/ProjectSettings/ProjectSettings.asset b/GameLift-Unity/ProjectSettings/ProjectSettings.asset deleted file mode 100644 index 0437707f..00000000 --- a/GameLift-Unity/ProjectSettings/ProjectSettings.asset +++ /dev/null @@ -1,645 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!129 &1 -PlayerSettings: - m_ObjectHideFlags: 0 - serializedVersion: 18 - productGUID: e5fc3bcba48ddc8458fdb2f473e0eb2f - AndroidProfiler: 0 - AndroidFilterTouchesWhenObscured: 0 - AndroidEnableSustainedPerformanceMode: 0 - defaultScreenOrientation: 4 - targetDevice: 2 - useOnDemandResources: 0 - accelerometerFrequency: 60 - companyName: DefaultCompany - productName: GameLift-Unity - defaultCursor: {fileID: 0} - cursorHotspot: {x: 0, y: 0} - m_SplashScreenBackgroundColor: {r: 0.13725491, g: 0.12156863, b: 0.1254902, a: 1} - m_ShowUnitySplashScreen: 1 - m_ShowUnitySplashLogo: 1 - m_SplashScreenOverlayOpacity: 1 - m_SplashScreenAnimation: 1 - m_SplashScreenLogoStyle: 1 - m_SplashScreenDrawMode: 0 - m_SplashScreenBackgroundAnimationZoom: 1 - m_SplashScreenLogoAnimationZoom: 1 - m_SplashScreenBackgroundLandscapeAspect: 1 - m_SplashScreenBackgroundPortraitAspect: 1 - m_SplashScreenBackgroundLandscapeUvs: - serializedVersion: 2 - x: 0 - y: 0 - width: 1 - height: 1 - m_SplashScreenBackgroundPortraitUvs: - serializedVersion: 2 - x: 0 - y: 0 - width: 1 - height: 1 - m_SplashScreenLogos: [] - m_VirtualRealitySplashScreen: {fileID: 0} - m_HolographicTrackingLossScreen: {fileID: 0} - defaultScreenWidth: 1024 - defaultScreenHeight: 768 - defaultScreenWidthWeb: 960 - defaultScreenHeightWeb: 600 - m_StereoRenderingPath: 0 - m_ActiveColorSpace: 0 - m_MTRendering: 1 - m_StackTraceTypes: 010000000100000001000000010000000100000001000000 - iosShowActivityIndicatorOnLoading: -1 - androidShowActivityIndicatorOnLoading: -1 - displayResolutionDialog: 1 - iosUseCustomAppBackgroundBehavior: 0 - iosAllowHTTPDownload: 1 - allowedAutorotateToPortrait: 1 - allowedAutorotateToPortraitUpsideDown: 1 - allowedAutorotateToLandscapeRight: 1 - allowedAutorotateToLandscapeLeft: 1 - useOSAutorotation: 1 - use32BitDisplayBuffer: 1 - preserveFramebufferAlpha: 0 - disableDepthAndStencilBuffers: 0 - androidStartInFullscreen: 1 - androidRenderOutsideSafeArea: 0 - androidBlitType: 0 - defaultIsNativeResolution: 1 - macRetinaSupport: 1 - runInBackground: 1 - captureSingleScreen: 0 - muteOtherAudioSources: 0 - Prepare IOS For Recording: 0 - Force IOS Speakers When Recording: 0 - deferSystemGesturesMode: 0 - hideHomeButton: 0 - submitAnalytics: 1 - usePlayerLog: 1 - bakeCollisionMeshes: 0 - forceSingleInstance: 0 - resizableWindow: 0 - useMacAppStoreValidation: 0 - macAppStoreCategory: public.app-category.games - gpuSkinning: 1 - graphicsJobs: 0 - xboxPIXTextureCapture: 0 - xboxEnableAvatar: 0 - xboxEnableKinect: 0 - xboxEnableKinectAutoTracking: 0 - xboxEnableFitness: 0 - visibleInBackground: 1 - allowFullscreenSwitch: 1 - graphicsJobMode: 0 - fullscreenMode: 1 - xboxSpeechDB: 0 - xboxEnableHeadOrientation: 0 - xboxEnableGuest: 0 - xboxEnablePIXSampling: 0 - metalFramebufferOnly: 0 - xboxOneResolution: 0 - xboxOneSResolution: 0 - xboxOneXResolution: 3 - xboxOneMonoLoggingLevel: 0 - xboxOneLoggingLevel: 1 - xboxOneDisableEsram: 0 - xboxOneEnableTypeOptimization: 0 - xboxOnePresentImmediateThreshold: 0 - switchQueueCommandMemory: 0 - switchQueueControlMemory: 16384 - switchQueueComputeMemory: 262144 - switchNVNShaderPoolsGranularity: 33554432 - switchNVNDefaultPoolsGranularity: 16777216 - switchNVNOtherPoolsGranularity: 16777216 - switchNVNMaxPublicTextureIDCount: 0 - switchNVNMaxPublicSamplerIDCount: 0 - vulkanEnableSetSRGBWrite: 0 - m_SupportedAspectRatios: - 4:3: 1 - 5:4: 1 - 16:10: 1 - 16:9: 1 - Others: 1 - bundleVersion: 0.1 - preloadedAssets: [] - metroInputSource: 0 - wsaTransparentSwapchain: 0 - m_HolographicPauseOnTrackingLoss: 1 - xboxOneDisableKinectGpuReservation: 1 - xboxOneEnable7thCore: 1 - isWsaHolographicRemotingEnabled: 0 - vrSettings: - cardboard: - depthFormat: 0 - enableTransitionView: 0 - daydream: - depthFormat: 0 - useSustainedPerformanceMode: 0 - enableVideoLayer: 0 - useProtectedVideoMemory: 0 - minimumSupportedHeadTracking: 0 - maximumSupportedHeadTracking: 1 - hololens: - depthFormat: 1 - depthBufferSharingEnabled: 1 - oculus: - sharedDepthBuffer: 1 - dashSupport: 1 - lowOverheadMode: 0 - protectedContext: 0 - v2Signing: 0 - enable360StereoCapture: 0 - protectGraphicsMemory: 0 - enableFrameTimingStats: 0 - useHDRDisplay: 0 - m_ColorGamuts: 00000000 - targetPixelDensity: 30 - resolutionScalingMode: 0 - androidSupportedAspectRatio: 1 - androidMaxAspectRatio: 2.1 - applicationIdentifier: - Standalone: com.Amazon.gameLift-Unity - buildNumber: {} - AndroidBundleVersionCode: 1 - AndroidMinSdkVersion: 16 - AndroidTargetSdkVersion: 0 - AndroidPreferredInstallLocation: 1 - aotOptions: - stripEngineCode: 1 - iPhoneStrippingLevel: 0 - iPhoneScriptCallOptimization: 0 - ForceInternetPermission: 0 - ForceSDCardPermission: 0 - CreateWallpaper: 0 - APKExpansionFiles: 0 - keepLoadedShadersAlive: 0 - StripUnusedMeshComponents: 1 - VertexChannelCompressionMask: 4054 - iPhoneSdkVersion: 988 - iOSTargetOSVersionString: 9.0 - tvOSSdkVersion: 0 - tvOSRequireExtendedGameController: 0 - tvOSTargetOSVersionString: 9.0 - uIPrerenderedIcon: 0 - uIRequiresPersistentWiFi: 0 - uIRequiresFullScreen: 1 - uIStatusBarHidden: 1 - uIExitOnSuspend: 0 - uIStatusBarStyle: 0 - iPhoneSplashScreen: {fileID: 0} - iPhoneHighResSplashScreen: {fileID: 0} - iPhoneTallHighResSplashScreen: {fileID: 0} - iPhone47inSplashScreen: {fileID: 0} - iPhone55inPortraitSplashScreen: {fileID: 0} - iPhone55inLandscapeSplashScreen: {fileID: 0} - iPhone58inPortraitSplashScreen: {fileID: 0} - iPhone58inLandscapeSplashScreen: {fileID: 0} - iPadPortraitSplashScreen: {fileID: 0} - iPadHighResPortraitSplashScreen: {fileID: 0} - iPadLandscapeSplashScreen: {fileID: 0} - iPadHighResLandscapeSplashScreen: {fileID: 0} - appleTVSplashScreen: {fileID: 0} - appleTVSplashScreen2x: {fileID: 0} - tvOSSmallIconLayers: [] - tvOSSmallIconLayers2x: [] - tvOSLargeIconLayers: [] - tvOSLargeIconLayers2x: [] - tvOSTopShelfImageLayers: [] - tvOSTopShelfImageLayers2x: [] - tvOSTopShelfImageWideLayers: [] - tvOSTopShelfImageWideLayers2x: [] - iOSLaunchScreenType: 0 - iOSLaunchScreenPortrait: {fileID: 0} - iOSLaunchScreenLandscape: {fileID: 0} - iOSLaunchScreenBackgroundColor: - serializedVersion: 2 - rgba: 0 - iOSLaunchScreenFillPct: 100 - iOSLaunchScreenSize: 100 - iOSLaunchScreenCustomXibPath: - iOSLaunchScreeniPadType: 0 - iOSLaunchScreeniPadImage: {fileID: 0} - iOSLaunchScreeniPadBackgroundColor: - serializedVersion: 2 - rgba: 0 - iOSLaunchScreeniPadFillPct: 100 - iOSLaunchScreeniPadSize: 100 - iOSLaunchScreeniPadCustomXibPath: - iOSUseLaunchScreenStoryboard: 0 - iOSLaunchScreenCustomStoryboardPath: - iOSDeviceRequirements: [] - iOSURLSchemes: [] - iOSBackgroundModes: 0 - iOSMetalForceHardShadows: 0 - metalEditorSupport: 1 - metalAPIValidation: 1 - iOSRenderExtraFrameOnPause: 0 - iosCopyPluginsCodeInsteadOfSymlink: 0 - appleDeveloperTeamID: - iOSManualSigningProvisioningProfileID: - tvOSManualSigningProvisioningProfileID: - iOSManualSigningProvisioningProfileType: 0 - tvOSManualSigningProvisioningProfileType: 0 - appleEnableAutomaticSigning: 0 - iOSRequireARKit: 0 - iOSAutomaticallyDetectAndAddCapabilities: 1 - appleEnableProMotion: 0 - clonedFromGUID: c0afd0d1d80e3634a9dac47e8a0426ea - templatePackageId: com.unity.template.3d@1.3.0 - templateDefaultScene: Assets/Scenes/SampleScene.unity - AndroidTargetArchitectures: 5 - AndroidSplashScreenScale: 0 - androidSplashScreen: {fileID: 0} - AndroidKeystoreName: - AndroidKeyaliasName: - AndroidBuildApkPerCpuArchitecture: 0 - AndroidTVCompatibility: 1 - AndroidIsGame: 1 - AndroidEnableTango: 0 - androidEnableBanner: 1 - androidUseLowAccuracyLocation: 0 - m_AndroidBanners: - - width: 320 - height: 180 - banner: {fileID: 0} - androidGamepadSupportLevel: 0 - resolutionDialogBanner: {fileID: 0} - m_BuildTargetIcons: [] - m_BuildTargetPlatformIcons: [] - m_BuildTargetBatching: - - m_BuildTarget: Standalone - m_StaticBatching: 1 - m_DynamicBatching: 0 - - m_BuildTarget: tvOS - m_StaticBatching: 1 - m_DynamicBatching: 0 - - m_BuildTarget: Android - m_StaticBatching: 1 - m_DynamicBatching: 0 - - m_BuildTarget: iPhone - m_StaticBatching: 1 - m_DynamicBatching: 0 - - m_BuildTarget: WebGL - m_StaticBatching: 0 - m_DynamicBatching: 0 - m_BuildTargetGraphicsAPIs: - - m_BuildTarget: AndroidPlayer - m_APIs: 0b00000008000000 - m_Automatic: 1 - - m_BuildTarget: iOSSupport - m_APIs: 10000000 - m_Automatic: 1 - - m_BuildTarget: AppleTVSupport - m_APIs: 10000000 - m_Automatic: 0 - - m_BuildTarget: WebGLSupport - m_APIs: 0b000000 - m_Automatic: 1 - m_BuildTargetVRSettings: - - m_BuildTarget: Standalone - m_Enabled: 0 - m_Devices: - - Oculus - - OpenVR - m_BuildTargetEnableVuforiaSettings: [] - openGLRequireES31: 0 - openGLRequireES31AEP: 0 - m_TemplateCustomTags: {} - mobileMTRendering: - Android: 1 - iPhone: 1 - tvOS: 1 - m_BuildTargetGroupLightmapEncodingQuality: [] - m_BuildTargetGroupLightmapSettings: [] - playModeTestRunnerEnabled: 0 - runPlayModeTestAsEditModeTest: 0 - actionOnDotNetUnhandledException: 1 - enableInternalProfiler: 0 - logObjCUncaughtExceptions: 1 - enableCrashReportAPI: 0 - cameraUsageDescription: - locationUsageDescription: - microphoneUsageDescription: - switchNetLibKey: - switchSocketMemoryPoolSize: 6144 - switchSocketAllocatorPoolSize: 128 - switchSocketConcurrencyLimit: 14 - switchScreenResolutionBehavior: 2 - switchUseCPUProfiler: 0 - switchApplicationID: 0x01004b9000490000 - switchNSODependencies: - switchTitleNames_0: - switchTitleNames_1: - switchTitleNames_2: - switchTitleNames_3: - switchTitleNames_4: - switchTitleNames_5: - switchTitleNames_6: - switchTitleNames_7: - switchTitleNames_8: - switchTitleNames_9: - switchTitleNames_10: - switchTitleNames_11: - switchTitleNames_12: - switchTitleNames_13: - switchTitleNames_14: - switchTitleNames_15: - switchPublisherNames_0: - switchPublisherNames_1: - switchPublisherNames_2: - switchPublisherNames_3: - switchPublisherNames_4: - switchPublisherNames_5: - switchPublisherNames_6: - switchPublisherNames_7: - switchPublisherNames_8: - switchPublisherNames_9: - switchPublisherNames_10: - switchPublisherNames_11: - switchPublisherNames_12: - switchPublisherNames_13: - switchPublisherNames_14: - switchPublisherNames_15: - switchIcons_0: {fileID: 0} - switchIcons_1: {fileID: 0} - switchIcons_2: {fileID: 0} - switchIcons_3: {fileID: 0} - switchIcons_4: {fileID: 0} - switchIcons_5: {fileID: 0} - switchIcons_6: {fileID: 0} - switchIcons_7: {fileID: 0} - switchIcons_8: {fileID: 0} - switchIcons_9: {fileID: 0} - switchIcons_10: {fileID: 0} - switchIcons_11: {fileID: 0} - switchIcons_12: {fileID: 0} - switchIcons_13: {fileID: 0} - switchIcons_14: {fileID: 0} - switchIcons_15: {fileID: 0} - switchSmallIcons_0: {fileID: 0} - switchSmallIcons_1: {fileID: 0} - switchSmallIcons_2: {fileID: 0} - switchSmallIcons_3: {fileID: 0} - switchSmallIcons_4: {fileID: 0} - switchSmallIcons_5: {fileID: 0} - switchSmallIcons_6: {fileID: 0} - switchSmallIcons_7: {fileID: 0} - switchSmallIcons_8: {fileID: 0} - switchSmallIcons_9: {fileID: 0} - switchSmallIcons_10: {fileID: 0} - switchSmallIcons_11: {fileID: 0} - switchSmallIcons_12: {fileID: 0} - switchSmallIcons_13: {fileID: 0} - switchSmallIcons_14: {fileID: 0} - switchSmallIcons_15: {fileID: 0} - switchManualHTML: - switchAccessibleURLs: - switchLegalInformation: - switchMainThreadStackSize: 1048576 - switchPresenceGroupId: - switchLogoHandling: 0 - switchReleaseVersion: 0 - switchDisplayVersion: 1.0.0 - switchStartupUserAccount: 0 - switchTouchScreenUsage: 0 - switchSupportedLanguagesMask: 0 - switchLogoType: 0 - switchApplicationErrorCodeCategory: - switchUserAccountSaveDataSize: 0 - switchUserAccountSaveDataJournalSize: 0 - switchApplicationAttribute: 0 - switchCardSpecSize: -1 - switchCardSpecClock: -1 - switchRatingsMask: 0 - switchRatingsInt_0: 0 - switchRatingsInt_1: 0 - switchRatingsInt_2: 0 - switchRatingsInt_3: 0 - switchRatingsInt_4: 0 - switchRatingsInt_5: 0 - switchRatingsInt_6: 0 - switchRatingsInt_7: 0 - switchRatingsInt_8: 0 - switchRatingsInt_9: 0 - switchRatingsInt_10: 0 - switchRatingsInt_11: 0 - switchRatingsInt_12: 0 - switchLocalCommunicationIds_0: - switchLocalCommunicationIds_1: - switchLocalCommunicationIds_2: - switchLocalCommunicationIds_3: - switchLocalCommunicationIds_4: - switchLocalCommunicationIds_5: - switchLocalCommunicationIds_6: - switchLocalCommunicationIds_7: - switchParentalControl: 0 - switchAllowsScreenshot: 1 - switchAllowsVideoCapturing: 1 - switchAllowsRuntimeAddOnContentInstall: 0 - switchDataLossConfirmation: 0 - switchUserAccountLockEnabled: 0 - switchSystemResourceMemory: 16777216 - switchSupportedNpadStyles: 3 - switchNativeFsCacheSize: 32 - switchIsHoldTypeHorizontal: 0 - switchSupportedNpadCount: 8 - switchSocketConfigEnabled: 0 - switchTcpInitialSendBufferSize: 32 - switchTcpInitialReceiveBufferSize: 64 - switchTcpAutoSendBufferSizeMax: 256 - switchTcpAutoReceiveBufferSizeMax: 256 - switchUdpSendBufferSize: 9 - switchUdpReceiveBufferSize: 42 - switchSocketBufferEfficiency: 4 - switchSocketInitializeEnabled: 1 - switchNetworkInterfaceManagerInitializeEnabled: 1 - switchPlayerConnectionEnabled: 1 - ps4NPAgeRating: 12 - ps4NPTitleSecret: - ps4NPTrophyPackPath: - ps4ParentalLevel: 11 - ps4ContentID: ED1633-NPXX51362_00-0000000000000000 - ps4Category: 0 - ps4MasterVersion: 01.00 - ps4AppVersion: 01.00 - ps4AppType: 0 - ps4ParamSfxPath: - ps4VideoOutPixelFormat: 0 - ps4VideoOutInitialWidth: 1920 - ps4VideoOutBaseModeInitialWidth: 1920 - ps4VideoOutReprojectionRate: 60 - ps4PronunciationXMLPath: - ps4PronunciationSIGPath: - ps4BackgroundImagePath: - ps4StartupImagePath: - ps4StartupImagesFolder: - ps4IconImagesFolder: - ps4SaveDataImagePath: - ps4SdkOverride: - ps4BGMPath: - ps4ShareFilePath: - ps4ShareOverlayImagePath: - ps4PrivacyGuardImagePath: - ps4ExtraSceSysFile: - ps4NPtitleDatPath: - ps4RemotePlayKeyAssignment: -1 - ps4RemotePlayKeyMappingDir: - ps4PlayTogetherPlayerCount: 0 - ps4EnterButtonAssignment: 1 - ps4ApplicationParam1: 0 - ps4ApplicationParam2: 0 - ps4ApplicationParam3: 0 - ps4ApplicationParam4: 0 - ps4DownloadDataSize: 0 - ps4GarlicHeapSize: 2048 - ps4ProGarlicHeapSize: 2560 - ps4Passcode: frAQBc8Wsa1xVPfvJcrgRYwTiizs2trQ - ps4pnSessions: 1 - ps4pnPresence: 1 - ps4pnFriends: 1 - ps4pnGameCustomData: 1 - playerPrefsSupport: 0 - enableApplicationExit: 0 - resetTempFolder: 1 - restrictedAudioUsageRights: 0 - ps4UseResolutionFallback: 0 - ps4ReprojectionSupport: 0 - ps4UseAudio3dBackend: 0 - ps4SocialScreenEnabled: 0 - ps4ScriptOptimizationLevel: 0 - ps4Audio3dVirtualSpeakerCount: 14 - ps4attribCpuUsage: 0 - ps4PatchPkgPath: - ps4PatchLatestPkgPath: - ps4PatchChangeinfoPath: - ps4PatchDayOne: 0 - ps4attribUserManagement: 0 - ps4attribMoveSupport: 0 - ps4attrib3DSupport: 0 - ps4attribShareSupport: 0 - ps4attribExclusiveVR: 0 - ps4disableAutoHideSplash: 0 - ps4videoRecordingFeaturesUsed: 0 - ps4contentSearchFeaturesUsed: 0 - ps4CompatibilityPS5: 0 - ps4GPU800MHz: 1 - ps4attribEyeToEyeDistanceSettingVR: 0 - ps4IncludedModules: [] - monoEnv: - splashScreenBackgroundSourceLandscape: {fileID: 0} - splashScreenBackgroundSourcePortrait: {fileID: 0} - spritePackerPolicy: - webGLMemorySize: 256 - webGLExceptionSupport: 1 - webGLNameFilesAsHashes: 0 - webGLDataCaching: 1 - webGLDebugSymbols: 0 - webGLEmscriptenArgs: - webGLModulesDirectory: - webGLTemplate: APPLICATION:Default - webGLAnalyzeBuildSize: 0 - webGLUseEmbeddedResources: 0 - webGLCompressionFormat: 1 - webGLLinkerTarget: 1 - webGLThreadsSupport: 0 - scriptingDefineSymbols: {} - platformArchitecture: {} - scriptingBackend: {} - il2cppCompilerConfiguration: {} - managedStrippingLevel: {} - incrementalIl2cppBuild: {} - allowUnsafeCode: 0 - additionalIl2CppArgs: - scriptingRuntimeVersion: 1 - apiCompatibilityLevelPerPlatform: - Standalone: 3 - m_RenderingPath: 1 - m_MobileRenderingPath: 1 - metroPackageName: Template_3D - metroPackageVersion: - metroCertificatePath: - metroCertificatePassword: - metroCertificateSubject: - metroCertificateIssuer: - metroCertificateNotAfter: 0000000000000000 - metroApplicationDescription: Template_3D - wsaImages: {} - metroTileShortName: - metroTileShowName: 0 - metroMediumTileShowName: 0 - metroLargeTileShowName: 0 - metroWideTileShowName: 0 - metroSupportStreamingInstall: 0 - metroLastRequiredScene: 0 - metroDefaultTileSize: 1 - metroTileForegroundText: 2 - metroTileBackgroundColor: {r: 0.13333334, g: 0.17254902, b: 0.21568628, a: 0} - metroSplashScreenBackgroundColor: {r: 0.12941177, g: 0.17254902, b: 0.21568628, - a: 1} - metroSplashScreenUseBackgroundColor: 0 - platformCapabilities: {} - metroTargetDeviceFamilies: {} - metroFTAName: - metroFTAFileTypes: [] - metroProtocolName: - metroCompilationOverrides: 1 - XboxOneProductId: - XboxOneUpdateKey: - XboxOneSandboxId: - XboxOneContentId: - XboxOneTitleId: - XboxOneSCId: - XboxOneGameOsOverridePath: - XboxOnePackagingOverridePath: - XboxOneAppManifestOverridePath: - XboxOneVersion: 1.0.0.0 - XboxOnePackageEncryption: 0 - XboxOnePackageUpdateGranularity: 2 - XboxOneDescription: - XboxOneLanguage: - - enus - XboxOneCapability: [] - XboxOneGameRating: {} - XboxOneIsContentPackage: 0 - XboxOneEnableGPUVariability: 1 - XboxOneSockets: {} - XboxOneSplashScreen: {fileID: 0} - XboxOneAllowedProductIds: [] - XboxOnePersistentLocalStorageSize: 0 - XboxOneXTitleMemory: 8 - xboxOneScriptCompiler: 1 - XboxOneOverrideIdentityName: - vrEditorSettings: - daydream: - daydreamIconForeground: {fileID: 0} - daydreamIconBackground: {fileID: 0} - cloudServicesEnabled: - UNet: 1 - luminIcon: - m_Name: - m_ModelFolderPath: - m_PortalFolderPath: - luminCert: - m_CertPath: - m_PrivateKeyPath: - luminIsChannelApp: 0 - luminVersion: - m_VersionCode: 1 - m_VersionName: - facebookSdkVersion: 7.9.4 - facebookAppId: - facebookCookies: 1 - facebookLogging: 1 - facebookStatus: 1 - facebookXfbml: 0 - facebookFrictionlessRequests: 1 - apiCompatibilityLevel: 6 - cloudProjectId: - framebufferDepthMemorylessMode: 0 - projectName: - organizationId: - cloudEnabled: 0 - enableNativePlatformBackendsForNewInputSystem: 0 - disableOldInputManagerSupport: 0 - legacyClampBlendShapeWeights: 0 diff --git a/GameLift-Unity/ProjectSettings/ProjectVersion.txt b/GameLift-Unity/ProjectSettings/ProjectVersion.txt deleted file mode 100644 index 35d8282d..00000000 --- a/GameLift-Unity/ProjectSettings/ProjectVersion.txt +++ /dev/null @@ -1,2 +0,0 @@ -m_EditorVersion: 2020.3.16f1 -m_EditorVersionWithRevision: 2020.3.16f1 (049d6eca3c44) diff --git a/GameLift-Unity/ProjectSettings/QualitySettings.asset b/GameLift-Unity/ProjectSettings/QualitySettings.asset deleted file mode 100644 index 0621bef1..00000000 --- a/GameLift-Unity/ProjectSettings/QualitySettings.asset +++ /dev/null @@ -1,190 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!47 &1 -QualitySettings: - m_ObjectHideFlags: 0 - serializedVersion: 5 - m_CurrentQuality: 4 - m_QualitySettings: - - serializedVersion: 2 - name: Very Low - pixelLightCount: 0 - shadows: 0 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 15 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 1 - textureQuality: 1 - anisotropicTextures: 0 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 0 - lodBias: 0.3 - maximumLODLevel: 0 - particleRaycastBudget: 4 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Low - pixelLightCount: 0 - shadows: 0 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 20 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 0 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 0 - lodBias: 0.4 - maximumLODLevel: 0 - particleRaycastBudget: 16 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Medium - pixelLightCount: 1 - shadows: 1 - shadowResolution: 0 - shadowProjection: 1 - shadowCascades: 1 - shadowDistance: 20 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 0 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 0 - softParticles: 0 - softVegetation: 0 - realtimeReflectionProbes: 0 - billboardsFaceCameraPosition: 0 - vSyncCount: 1 - lodBias: 0.7 - maximumLODLevel: 0 - particleRaycastBudget: 64 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: High - pixelLightCount: 2 - shadows: 2 - shadowResolution: 1 - shadowProjection: 1 - shadowCascades: 2 - shadowDistance: 40 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 2 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 2 - softParticles: 0 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 1 - maximumLODLevel: 0 - particleRaycastBudget: 256 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Very High - pixelLightCount: 3 - shadows: 2 - shadowResolution: 2 - shadowProjection: 1 - shadowCascades: 2 - shadowDistance: 40 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 4 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 4 - softParticles: 1 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 1.5 - maximumLODLevel: 0 - particleRaycastBudget: 1024 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - - serializedVersion: 2 - name: Ultra - pixelLightCount: 4 - shadows: 2 - shadowResolution: 2 - shadowProjection: 1 - shadowCascades: 4 - shadowDistance: 150 - shadowNearPlaneOffset: 3 - shadowCascade2Split: 0.33333334 - shadowCascade4Split: {x: 0.06666667, y: 0.2, z: 0.46666667} - shadowmaskMode: 1 - blendWeights: 4 - textureQuality: 0 - anisotropicTextures: 1 - antiAliasing: 4 - softParticles: 1 - softVegetation: 1 - realtimeReflectionProbes: 1 - billboardsFaceCameraPosition: 1 - vSyncCount: 1 - lodBias: 2 - maximumLODLevel: 0 - particleRaycastBudget: 4096 - asyncUploadTimeSlice: 2 - asyncUploadBufferSize: 16 - resolutionScalingFixedDPIFactor: 1 - excludedTargetPlatforms: [] - m_PerPlatformDefaultQuality: - Android: 2 - Nintendo 3DS: 5 - Nintendo Switch: 5 - PS4: 5 - PSP2: 2 - Standalone: 5 - Tizen: 2 - WebGL: 3 - WiiU: 5 - Windows Store Apps: 5 - XboxOne: 5 - iPhone: 2 - tvOS: 2 diff --git a/GameLift-Unity/ProjectSettings/TagManager.asset b/GameLift-Unity/ProjectSettings/TagManager.asset deleted file mode 100644 index 17cb8036..00000000 --- a/GameLift-Unity/ProjectSettings/TagManager.asset +++ /dev/null @@ -1,43 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!78 &1 -TagManager: - serializedVersion: 2 - tags: [] - layers: - - Default - - TransparentFX - - Ignore Raycast - - - - Water - - UI - - - - - - PostProcessing - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - m_SortingLayers: - - name: Default - uniqueID: 0 - locked: 0 diff --git a/GameLift-Unity/ProjectSettings/TimeManager.asset b/GameLift-Unity/ProjectSettings/TimeManager.asset deleted file mode 100644 index 06bcc6d2..00000000 --- a/GameLift-Unity/ProjectSettings/TimeManager.asset +++ /dev/null @@ -1,9 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!5 &1 -TimeManager: - m_ObjectHideFlags: 0 - Fixed Timestep: 0.02 - Maximum Allowed Timestep: 0.1 - m_TimeScale: 1 - Maximum Particle Timestep: 0.03 diff --git a/GameLift-Unity/ProjectSettings/UnityConnectSettings.asset b/GameLift-Unity/ProjectSettings/UnityConnectSettings.asset deleted file mode 100644 index fa0b1465..00000000 --- a/GameLift-Unity/ProjectSettings/UnityConnectSettings.asset +++ /dev/null @@ -1,34 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!310 &1 -UnityConnectSettings: - m_ObjectHideFlags: 0 - serializedVersion: 1 - m_Enabled: 0 - m_TestMode: 0 - m_EventOldUrl: https://api.uca.cloud.unity3d.com/v1/events - m_EventUrl: https://cdp.cloud.unity3d.com/v1/events - m_ConfigUrl: https://config.uca.cloud.unity3d.com - m_TestInitMode: 0 - CrashReportingSettings: - m_EventUrl: https://perf-events.cloud.unity3d.com - m_Enabled: 0 - m_LogBufferSize: 10 - m_CaptureEditorExceptions: 1 - UnityPurchasingSettings: - m_Enabled: 0 - m_TestMode: 0 - UnityAnalyticsSettings: - m_Enabled: 0 - m_TestMode: 0 - m_InitializeOnStartup: 1 - UnityAdsSettings: - m_Enabled: 0 - m_InitializeOnStartup: 1 - m_TestMode: 0 - m_IosGameId: - m_AndroidGameId: - m_GameIds: {} - m_GameId: - PerformanceReportingSettings: - m_Enabled: 0 diff --git a/GameLift-Unity/ProjectSettings/VFXManager.asset b/GameLift-Unity/ProjectSettings/VFXManager.asset deleted file mode 100644 index 6e0eaca4..00000000 --- a/GameLift-Unity/ProjectSettings/VFXManager.asset +++ /dev/null @@ -1,11 +0,0 @@ -%YAML 1.1 -%TAG !u! tag:unity3d.com,2011: ---- !u!937362698 &1 -VFXManager: - m_ObjectHideFlags: 0 - m_IndirectShader: {fileID: 0} - m_CopyBufferShader: {fileID: 0} - m_SortShader: {fileID: 0} - m_RenderPipeSettingsPath: - m_FixedTimeStep: 0.016666668 - m_MaxDeltaTime: 0.05 diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml.meta b/LICENSE.md.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml.meta rename to LICENSE.md.meta index 38f5f51a..23b86d4c 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/AWSSDK.Core.xml.meta +++ b/LICENSE.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: cdca939ef8bf09d4885bb8dc74b8c709 +guid: 11f7535658609ba4b9fa4606316bec9e TextScriptImporter: externalObjects: {} userData: diff --git a/NOTICE.md.meta b/NOTICE.md.meta new file mode 100644 index 00000000..8244e9b5 --- /dev/null +++ b/NOTICE.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 13b0bd4144b4f27419361a5d4eb62ee2 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/README.md b/README.md index fc440172..fd74fb06 100644 --- a/README.md +++ b/README.md @@ -235,28 +235,27 @@ rights on your machine: * .NET 4.7.1 Developer Pack to build AmazonGameLiftPlugin.Core. This can be downloaded at https://dotnet.microsoft.com/download/visual-studio-sdks, or as a part of MS Visual Studio. -### How to make changes to the plugin UI? +### How to make changes to the plugin? -1. Clone the **amazon-gamelift-plugin-unity** repository -2. In Unity Hub, open project, and select `GameLift-Unity` directory as the project root -3. Make changes to the plugin code, and Unity should recompile after each change -4. To enable Unity debug mode and set breakpoint in the code, - see: https://docs.unity3d.com/Manual/ManagedCodeDebugging.html -5. Once changes are made, run the Editor unit tests via **Window > General > Test Runner, Edit Mode** +1. Clone the **amazon-gamelift-plugin-unity** repository from GitHub +1. In Unity Hub, create a new project +1. Open Unity Package Manager, import project from disk, and select the `package.json` located in the project root +1. Setup code debugging in Unity: https://docs.unity3d.com/Manual/ManagedCodeDebugging.html, and change Unity project to + Debug Mode +1. A .sln file should be created in the Unity project root, you can open that with Visual Studio +1. Make changes to the plugin code, and Unity should recompile after each change +1. Once changes are made, run the unit tests via **Window > General > Test Runner** -### How to make changes to the Plugin Core Library? +### How to build and package the plugin? -1. Open `AmazonGameLiftPlugin.Core\AmazonGameLiftPlugin.Core.sln` with Visual Studio. -2. Make changes -3. Run unit tests in `AmazonGameLiftPlugin.Core.Tests` from Visual Studio -4. Run `bin\windows\clean.ps1` then `bin\windows\setup.ps` to recompile the core plugin DLL -5. Follow the above section to verify the changes in plugin UI +Run `Scripts~\windows\release.ps1` to clean, build and export the plugin into a tarball with a single command. -### How to build and package the plugin? +Alternatively: +1. Run `Scripts~\windows\clean.ps1` to delete all dlls and temp files (If you want to build faster, you can comment out + `.clean-download-files` execution) +1. Run `Scripts~\windows\build.ps1` to build dlls and sample game +1. Run `Scripts~\windows\export.ps1` to export the plugin into a tarball (.tgz) file stored in the project root folder -1. Run `bin\windows\clean.ps1` to delete all dlls and temp files -3. Run `bin\windows\setup.ps1` to build dlls -4. Run `bin\windows\build.ps1` to bundle the plugin into a tarball (.tgz) file The redistributable Plug-in files are located at **GameLift-Unity\Assets\com.amazonaws.gamelift**. If you want to update the sample game, open the GameLift-SampleGame project in Unity and run the main menu command at **Assets > Export diff --git a/README.md.meta b/README.md.meta new file mode 100644 index 00000000..08ff26ec --- /dev/null +++ b/README.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 1e643bcfff72735499ca5c5df5f86261 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime.meta b/Runtime.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime.meta rename to Runtime.meta diff --git a/Runtime/AmazonGameLiftPlugin.Runtime.asmdef b/Runtime/AmazonGameLiftPlugin.Runtime.asmdef new file mode 100644 index 00000000..f4b8b997 --- /dev/null +++ b/Runtime/AmazonGameLiftPlugin.Runtime.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.Runtime", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor", + "WindowsStandalone64" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef.meta b/Runtime/AmazonGameLiftPlugin.Runtime.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AmazonGameLiftPlugin.Runtime.asmdef.meta rename to Runtime/AmazonGameLiftPlugin.Runtime.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AssemblyInfo.cs b/Runtime/AssemblyInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AssemblyInfo.cs rename to Runtime/AssemblyInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AssemblyInfo.cs.meta b/Runtime/AssemblyInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/AssemblyInfo.cs.meta rename to Runtime/AssemblyInfo.cs.meta diff --git a/GameLift-Unity/Assets/Editor.meta b/Runtime/Core.meta similarity index 77% rename from GameLift-Unity/Assets/Editor.meta rename to Runtime/Core.meta index 26ba07db..16b51f5f 100644 --- a/GameLift-Unity/Assets/Editor.meta +++ b/Runtime/Core.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 12cf855f65e60c044b42d23ffc6595e1 +guid: 74909896b98bdce41a9a76c58093931d folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario.meta b/Runtime/Core/AccountManagement.meta similarity index 77% rename from GameLift-Unity/Assets/Editor/Custom Scenario.meta rename to Runtime/Core/AccountManagement.meta index 50ddbdcc..00e1b077 100644 --- a/GameLift-Unity/Assets/Editor/Custom Scenario.meta +++ b/Runtime/Core/AccountManagement.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: e6e29cfca56e1da468a93364f03e4437 +guid: 2502d9f2fac291141b1c8586cbf441ba folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/AccountManager.cs b/Runtime/Core/AccountManagement/AccountManager.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/AccountManager.cs rename to Runtime/Core/AccountManagement/AccountManager.cs diff --git a/GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs.meta b/Runtime/Core/AccountManagement/AccountManager.cs.meta similarity index 83% rename from GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs.meta rename to Runtime/Core/AccountManagement/AccountManager.cs.meta index fe602901..fbbd5889 100644 --- a/GameLift-Unity/Assets/Editor/Scripts/PluginPacker.cs.meta +++ b/Runtime/Core/AccountManagement/AccountManager.cs.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 4c3b0e5e38b22c54e8f7bd29300a66fd +guid: c46f161b60ee3c240ba515315103cbfa MonoImporter: externalObjects: {} serializedVersion: 2 diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs b/Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs rename to Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs diff --git a/GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs.meta b/Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs.meta similarity index 83% rename from GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs.meta rename to Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs.meta index ad33e742..b9f4a2cf 100644 --- a/GameLift-Unity/Assets/Editor/Scripts/CustomScenarioPackageExporter.cs.meta +++ b/Runtime/Core/AccountManagement/AmazonSecurityTokenServiceClientWrapper.cs.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 82f9053ea0808334ab5fe2a4f3f95584 +guid: d8fe1b8beeeadfc4a926a39bfc8fcfa5 MonoImporter: externalObjects: {} serializedVersion: 2 diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/IAccountManager.cs b/Runtime/Core/AccountManagement/IAccountManager.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/IAccountManager.cs rename to Runtime/Core/AccountManagement/IAccountManager.cs diff --git a/GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs.meta b/Runtime/Core/AccountManagement/IAccountManager.cs.meta similarity index 83% rename from GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs.meta rename to Runtime/Core/AccountManagement/IAccountManager.cs.meta index fa42780e..3ad3c0df 100644 --- a/GameLift-Unity/Assets/Editor/UiTests/StackUpdateDialogTest.cs.meta +++ b/Runtime/Core/AccountManagement/IAccountManager.cs.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: ef9df0d216dd0a941965e3e421f46325 +guid: 17063366a7258344ab9101313704d0f5 MonoImporter: externalObjects: {} serializedVersion: 2 diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs b/Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs rename to Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs diff --git a/Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs.meta b/Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs.meta new file mode 100644 index 00000000..c3ec3b03 --- /dev/null +++ b/Runtime/Core/AccountManagement/IAmazonSecurityTokenServiceClientWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 966d4ee649aca7c46a5eec1629db60cc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/Editor/Scripts.meta b/Runtime/Core/AccountManagement/Models.meta similarity index 77% rename from GameLift-Unity/Assets/Editor/Scripts.meta rename to Runtime/Core/AccountManagement/Models.meta index daf6b029..d3a25cde 100644 --- a/GameLift-Unity/Assets/Editor/Scripts.meta +++ b/Runtime/Core/AccountManagement/Models.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 5bb3cd874733a104dbc6e7c4fc1a0ded +guid: 1e1bc0e629e85b84db9e9d6f6940265f folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs b/Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs rename to Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs diff --git a/Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs.meta b/Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs.meta new file mode 100644 index 00000000..c09d741f --- /dev/null +++ b/Runtime/Core/AccountManagement/Models/RetrieveAccountIdByCredentialsRequest.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f616c22148e2ba34e8dc327a5224e4b3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/AmazonGameLiftPlugin.Core.csproj b/Runtime/Core/AmazonGameLiftPlugin.Core.csproj new file mode 100644 index 00000000..4bfa84dc --- /dev/null +++ b/Runtime/Core/AmazonGameLiftPlugin.Core.csproj @@ -0,0 +1,41 @@ + + + net471 + .\Plugins + none + Amazon.GameLiftPlugin.Core.tmp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Runtime/Core/AmazonGameLiftPlugin.Core.csproj.meta b/Runtime/Core/AmazonGameLiftPlugin.Core.csproj.meta new file mode 100644 index 00000000..f8cd52a8 --- /dev/null +++ b/Runtime/Core/AmazonGameLiftPlugin.Core.csproj.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 5c4e8d496187c9a4990c04bbb3c9e80a +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef b/Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef new file mode 100644 index 00000000..853a3c8b --- /dev/null +++ b/Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef @@ -0,0 +1,16 @@ +{ + "name": "AmazonGameLiftPlugin.Runtime.Core", + "rootNamespace": "", + "references": [], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [ + "System.IO.Compression.ZipFile.dll" + ], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef.meta b/Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef.meta similarity index 76% rename from GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef.meta rename to Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef.meta index 5114f783..474aac21 100644 --- a/GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef.meta +++ b/Runtime/Core/AmazonGameLiftPlugin.Runtime.Core.asmdef.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 3681419d7c3cb134fabbeaaf3b211973 +guid: 1ff874e170fe5f94eaf8f0a3ea344e83 AssemblyDefinitionImporter: externalObjects: {} userData: diff --git a/GameLift-Unity/Assets/Editor/UiTests.meta b/Runtime/Core/ApiGatewayManagement.meta similarity index 77% rename from GameLift-Unity/Assets/Editor/UiTests.meta rename to Runtime/Core/ApiGatewayManagement.meta index 4568c2fb..739df137 100644 --- a/GameLift-Unity/Assets/Editor/UiTests.meta +++ b/Runtime/Core/ApiGatewayManagement.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 29442ace6b288cf47baf18f225fc5202 +guid: 0313c036ba3563b40bd611dff3fc7e40 folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs b/Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs rename to Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs diff --git a/Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs.meta b/Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs.meta new file mode 100644 index 00000000..def5e7a5 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/AmazonGameLiftClientWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2b694d4e36ef0d44494ad221762be3b3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/ApiGateway.cs b/Runtime/Core/ApiGatewayManagement/ApiGateway.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/ApiGateway.cs rename to Runtime/Core/ApiGatewayManagement/ApiGateway.cs diff --git a/Runtime/Core/ApiGatewayManagement/ApiGateway.cs.meta b/Runtime/Core/ApiGatewayManagement/ApiGateway.cs.meta new file mode 100644 index 00000000..45d56d59 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/ApiGateway.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 95a482372a17fff439ae5d5908fed08b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/HttpClientWrapper.cs b/Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/HttpClientWrapper.cs rename to Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs diff --git a/Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs.meta b/Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs.meta new file mode 100644 index 00000000..a7832bff --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/HttpClientWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f276d7dc07d79e641a0005e895550923 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs b/Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs rename to Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs diff --git a/Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs.meta b/Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs.meta new file mode 100644 index 00000000..e92888c7 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/IAmazonGameLiftClientWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4a8c4324c0bfd324598214fe57f41d36 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IGameServerAdapter.cs b/Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IGameServerAdapter.cs rename to Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs diff --git a/Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs.meta b/Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs.meta new file mode 100644 index 00000000..7b0608bc --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/IGameServerAdapter.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b8eb612feba44b24a88d748b4d9c524c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IHttpClientWrapper.cs b/Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IHttpClientWrapper.cs rename to Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs diff --git a/Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs.meta b/Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs.meta new file mode 100644 index 00000000..5c2f8014 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/IHttpClientWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 35442ffce0ee2b94f93fa1f95f3d8755 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs b/Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs rename to Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs diff --git a/Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs.meta b/Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs.meta new file mode 100644 index 00000000..0c6c76cb --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/IJwtTokenExpirationCheck.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1368f9b0ff72b0c428e3ecbea98a77bb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs b/Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs rename to Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs diff --git a/Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs.meta b/Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs.meta new file mode 100644 index 00000000..ac28e73a --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/JwtTokenExpirationCheck.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: fbd6f4c67a706cb4cbb74dc5e9d859e9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/LocalGameAdapter.cs b/Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/LocalGameAdapter.cs rename to Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs diff --git a/Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs.meta b/Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs.meta new file mode 100644 index 00000000..7959b702 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/LocalGameAdapter.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bfc3906db9e854743b890e0b67a40ff1 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/ApiGatewayManagement/Models.meta b/Runtime/Core/ApiGatewayManagement/Models.meta new file mode 100644 index 00000000..7bae8bd3 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 5b3b8016d4b634042a139dac341da37b +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs b/Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs rename to Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs diff --git a/Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs.meta b/Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs.meta new file mode 100644 index 00000000..b3bf4f8b --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/Models/ApiGatewayRequest.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7ea89da52542dec478a779c570ae8d8e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/GetGameConnection.cs b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/GetGameConnection.cs rename to Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs diff --git a/Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs.meta b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs.meta new file mode 100644 index 00000000..024093f0 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnection.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 426fe92c8458e5e45af30de41d74ae00 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs rename to Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs diff --git a/Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs.meta b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs.meta new file mode 100644 index 00000000..1294769f --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/Models/GetGameConnectionResult.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 355d2ebc67c31bc4fb765b88aee5694d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/StartGame.cs b/Runtime/Core/ApiGatewayManagement/Models/StartGame.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/ApiGatewayManagement/Models/StartGame.cs rename to Runtime/Core/ApiGatewayManagement/Models/StartGame.cs diff --git a/Runtime/Core/ApiGatewayManagement/Models/StartGame.cs.meta b/Runtime/Core/ApiGatewayManagement/Models/StartGame.cs.meta new file mode 100644 index 00000000..480a4e02 --- /dev/null +++ b/Runtime/Core/ApiGatewayManagement/Models/StartGame.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 07307c66f0941634e9693443e19471ba +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/BucketManagement.meta b/Runtime/Core/BucketManagement.meta new file mode 100644 index 00000000..22e49fc6 --- /dev/null +++ b/Runtime/Core/BucketManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 8a301f49119d77c47a8ce128492a40a2 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/BucketStore.cs b/Runtime/Core/BucketManagement/BucketStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/BucketStore.cs rename to Runtime/Core/BucketManagement/BucketStore.cs diff --git a/Runtime/Core/BucketManagement/BucketStore.cs.meta b/Runtime/Core/BucketManagement/BucketStore.cs.meta new file mode 100644 index 00000000..936fdf7a --- /dev/null +++ b/Runtime/Core/BucketManagement/BucketStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 48b1636652ac2084c9cd4bc0e75cb7fa +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/IBucketStore.cs b/Runtime/Core/BucketManagement/IBucketStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/IBucketStore.cs rename to Runtime/Core/BucketManagement/IBucketStore.cs diff --git a/Runtime/Core/BucketManagement/IBucketStore.cs.meta b/Runtime/Core/BucketManagement/IBucketStore.cs.meta new file mode 100644 index 00000000..30d251eb --- /dev/null +++ b/Runtime/Core/BucketManagement/IBucketStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d23f9b3a9f67dfc408b19d5cd146af2c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/BucketManagement/Models.meta b/Runtime/Core/BucketManagement/Models.meta new file mode 100644 index 00000000..d829f1cc --- /dev/null +++ b/Runtime/Core/BucketManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 957183f704197814da734e840dc3268d +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/BucketPolicy.cs b/Runtime/Core/BucketManagement/Models/BucketPolicy.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/BucketPolicy.cs rename to Runtime/Core/BucketManagement/Models/BucketPolicy.cs diff --git a/Runtime/Core/BucketManagement/Models/BucketPolicy.cs.meta b/Runtime/Core/BucketManagement/Models/BucketPolicy.cs.meta new file mode 100644 index 00000000..08788884 --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/BucketPolicy.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ac014ab329590254696a8b0862c61b5d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/CreateBucket.cs b/Runtime/Core/BucketManagement/Models/CreateBucket.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/CreateBucket.cs rename to Runtime/Core/BucketManagement/Models/CreateBucket.cs diff --git a/Runtime/Core/BucketManagement/Models/CreateBucket.cs.meta b/Runtime/Core/BucketManagement/Models/CreateBucket.cs.meta new file mode 100644 index 00000000..69442e58 --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/CreateBucket.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 778bdd433f15ebb488e5c8ef8e8c0c2d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetAvailableRegions.cs b/Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetAvailableRegions.cs rename to Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs diff --git a/Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs.meta b/Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs.meta new file mode 100644 index 00000000..481c36e1 --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/GetAvailableRegions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8eaffa63524358b43b35be505682bc5d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetBucketPolicies.cs b/Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetBucketPolicies.cs rename to Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs diff --git a/Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs.meta b/Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs.meta new file mode 100644 index 00000000..a4bfd4f2 --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/GetBucketPolicies.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a400a1c653f94ba4fb50ba74337416c6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetBuckets.cs b/Runtime/Core/BucketManagement/Models/GetBuckets.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/GetBuckets.cs rename to Runtime/Core/BucketManagement/Models/GetBuckets.cs diff --git a/Runtime/Core/BucketManagement/Models/GetBuckets.cs.meta b/Runtime/Core/BucketManagement/Models/GetBuckets.cs.meta new file mode 100644 index 00000000..8e60f62c --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/GetBuckets.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b75d164cb6295cb4691915648e955ab2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/PutLifecycleConfiguration.cs b/Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/BucketManagement/Models/PutLifecycleConfiguration.cs rename to Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs diff --git a/Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs.meta b/Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs.meta new file mode 100644 index 00000000..26e21a9d --- /dev/null +++ b/Runtime/Core/BucketManagement/Models/PutLifecycleConfiguration.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e1936fb8b4ec4474cb24a48adc697b70 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/CredentialManagement.meta b/Runtime/Core/CredentialManagement.meta new file mode 100644 index 00000000..ebc8ecdc --- /dev/null +++ b/Runtime/Core/CredentialManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: d50acd7e1febfa44caf8d0de2137841f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/CredentialsStore.cs b/Runtime/Core/CredentialManagement/CredentialsStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/CredentialsStore.cs rename to Runtime/Core/CredentialManagement/CredentialsStore.cs diff --git a/Runtime/Core/CredentialManagement/CredentialsStore.cs.meta b/Runtime/Core/CredentialManagement/CredentialsStore.cs.meta new file mode 100644 index 00000000..da245a17 --- /dev/null +++ b/Runtime/Core/CredentialManagement/CredentialsStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1f2b612b78688f24b8fcbe36f9f54b2e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/ICredentialsStore.cs b/Runtime/Core/CredentialManagement/ICredentialsStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/ICredentialsStore.cs rename to Runtime/Core/CredentialManagement/ICredentialsStore.cs diff --git a/Runtime/Core/CredentialManagement/ICredentialsStore.cs.meta b/Runtime/Core/CredentialManagement/ICredentialsStore.cs.meta new file mode 100644 index 00000000..8e5eaafa --- /dev/null +++ b/Runtime/Core/CredentialManagement/ICredentialsStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8e0c9fd2de6792f4daf0a18981be1927 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/CredentialManagement/Models.meta b/Runtime/Core/CredentialManagement/Models.meta new file mode 100644 index 00000000..f5803091 --- /dev/null +++ b/Runtime/Core/CredentialManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 529eba506cba5354e93c8482ae43bc65 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/GetProfiles.cs b/Runtime/Core/CredentialManagement/Models/GetProfiles.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/GetProfiles.cs rename to Runtime/Core/CredentialManagement/Models/GetProfiles.cs diff --git a/Runtime/Core/CredentialManagement/Models/GetProfiles.cs.meta b/Runtime/Core/CredentialManagement/Models/GetProfiles.cs.meta new file mode 100644 index 00000000..675d4599 --- /dev/null +++ b/Runtime/Core/CredentialManagement/Models/GetProfiles.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e76a392f7a4e6a44dbb8be1234778fa8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/RetriveAwsCredentials.cs b/Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/RetriveAwsCredentials.cs rename to Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs diff --git a/Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs.meta b/Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs.meta new file mode 100644 index 00000000..d0b7bbf0 --- /dev/null +++ b/Runtime/Core/CredentialManagement/Models/RetriveAwsCredentials.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 53b4bf56ed3f76b4ba44dd9b03f66bdc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/SaveAwsCredentials.cs b/Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/SaveAwsCredentials.cs rename to Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs diff --git a/Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs.meta b/Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs.meta new file mode 100644 index 00000000..aea6dcc6 --- /dev/null +++ b/Runtime/Core/CredentialManagement/Models/SaveAwsCredentials.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: dc769e45b6e11584a846ae588eae559d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/UpdateAwsCredentials.cs b/Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/CredentialManagement/Models/UpdateAwsCredentials.cs rename to Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs diff --git a/Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs.meta b/Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs.meta new file mode 100644 index 00000000..1c1095f7 --- /dev/null +++ b/Runtime/Core/CredentialManagement/Models/UpdateAwsCredentials.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1c745a945c4efff478d8113a3d60010c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/DeploymentManagement.meta b/Runtime/Core/DeploymentManagement.meta new file mode 100644 index 00000000..130c426a --- /dev/null +++ b/Runtime/Core/DeploymentManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 7afac4d7d029bc8468a853a2701ea39f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/AmazonCloudFormationWrapper.cs b/Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/AmazonCloudFormationWrapper.cs rename to Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs diff --git a/Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs.meta b/Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs.meta new file mode 100644 index 00000000..6e7ea237 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/AmazonCloudFormationWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: aeca9e1354f50a747a2f59fc9c214270 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/DeploymentFormatter.cs b/Runtime/Core/DeploymentManagement/DeploymentFormatter.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/DeploymentFormatter.cs rename to Runtime/Core/DeploymentManagement/DeploymentFormatter.cs diff --git a/Runtime/Core/DeploymentManagement/DeploymentFormatter.cs.meta b/Runtime/Core/DeploymentManagement/DeploymentFormatter.cs.meta new file mode 100644 index 00000000..c8d5744b --- /dev/null +++ b/Runtime/Core/DeploymentManagement/DeploymentFormatter.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cbd115b5bfc089740a100c23d865d223 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/DeploymentManager.cs b/Runtime/Core/DeploymentManagement/DeploymentManager.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/DeploymentManager.cs rename to Runtime/Core/DeploymentManagement/DeploymentManager.cs diff --git a/Runtime/Core/DeploymentManagement/DeploymentManager.cs.meta b/Runtime/Core/DeploymentManagement/DeploymentManager.cs.meta new file mode 100644 index 00000000..8f27f024 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/DeploymentManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e641162866222a74a9c78d6d67cb727f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs b/Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs rename to Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs diff --git a/Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs.meta b/Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs.meta new file mode 100644 index 00000000..e35ab6af --- /dev/null +++ b/Runtime/Core/DeploymentManagement/IAmazonCloudFormationWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ef5712722063f3845a1c889b90f07ead +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/IDeploymentManager.cs b/Runtime/Core/DeploymentManagement/IDeploymentManager.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/IDeploymentManager.cs rename to Runtime/Core/DeploymentManagement/IDeploymentManager.cs diff --git a/Runtime/Core/DeploymentManagement/IDeploymentManager.cs.meta b/Runtime/Core/DeploymentManagement/IDeploymentManager.cs.meta new file mode 100644 index 00000000..b0406fd2 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/IDeploymentManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bd0633a1ee23a7c489eb14f48a39cfb3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/DeploymentManagement/Models.meta b/Runtime/Core/DeploymentManagement/Models.meta new file mode 100644 index 00000000..555c2dc7 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: dc575ab2966fd3e45a06de242a0fcf21 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/CancelDeployment.cs b/Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/CancelDeployment.cs rename to Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs diff --git a/Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs.meta b/Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs.meta new file mode 100644 index 00000000..cabd68ca --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/CancelDeployment.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c77f4ef584de63a41a73ffe3eaa4eb48 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/CreateChangeSet.cs b/Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/CreateChangeSet.cs rename to Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs diff --git a/Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs.meta b/Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs.meta new file mode 100644 index 00000000..e5960450 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/CreateChangeSet.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1020ca3382a12684983c6190874d0c6c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DeleteChangeSet.cs b/Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DeleteChangeSet.cs rename to Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs diff --git a/Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs.meta b/Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs.meta new file mode 100644 index 00000000..2b49ef06 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/DeleteChangeSet.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b6544be2de729e9469d2a6e5223445c5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DeleteStack.cs b/Runtime/Core/DeploymentManagement/Models/DeleteStack.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DeleteStack.cs rename to Runtime/Core/DeploymentManagement/Models/DeleteStack.cs diff --git a/Runtime/Core/DeploymentManagement/Models/DeleteStack.cs.meta b/Runtime/Core/DeploymentManagement/Models/DeleteStack.cs.meta new file mode 100644 index 00000000..e5ed43d8 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/DeleteStack.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a3d9126de171c164f980ba614d88c145 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DescribeChangeSet.cs b/Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DescribeChangeSet.cs rename to Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs diff --git a/Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs.meta b/Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs.meta new file mode 100644 index 00000000..88eca674 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/DescribeChangeSet.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 14032bf94abee134f9b3905fddbd16f3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DescribeStack.cs b/Runtime/Core/DeploymentManagement/Models/DescribeStack.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/DescribeStack.cs rename to Runtime/Core/DeploymentManagement/Models/DescribeStack.cs diff --git a/Runtime/Core/DeploymentManagement/Models/DescribeStack.cs.meta b/Runtime/Core/DeploymentManagement/Models/DescribeStack.cs.meta new file mode 100644 index 00000000..fc17dd5b --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/DescribeStack.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 27ba4cda5ff7cf040aa08be2ae3aacdc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/ExecuteChangeSet.cs b/Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/ExecuteChangeSet.cs rename to Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs diff --git a/Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs.meta b/Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs.meta new file mode 100644 index 00000000..5d346008 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/ExecuteChangeSet.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: eaef3c7d280e41544adce5f3c7838e80 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/StackExists.cs b/Runtime/Core/DeploymentManagement/Models/StackExists.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/StackExists.cs rename to Runtime/Core/DeploymentManagement/Models/StackExists.cs diff --git a/Runtime/Core/DeploymentManagement/Models/StackExists.cs.meta b/Runtime/Core/DeploymentManagement/Models/StackExists.cs.meta new file mode 100644 index 00000000..7d48bdb4 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/StackExists.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 54d8fb3aaa5aa88428c699d8b0cc0338 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/UploadServerBuild.cs b/Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/UploadServerBuild.cs rename to Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs diff --git a/Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs.meta b/Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs.meta new file mode 100644 index 00000000..210d7521 --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/UploadServerBuild.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 95c75944c9137ac4ea2b1e648634c26b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/ValidateCfnTemplate.cs b/Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/DeploymentManagement/Models/ValidateCfnTemplate.cs rename to Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs diff --git a/Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs.meta b/Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs.meta new file mode 100644 index 00000000..97160cfe --- /dev/null +++ b/Runtime/Core/DeploymentManagement/Models/ValidateCfnTemplate.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c39c30968b6cbb94fbd265510aba4f66 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/GameLiftLocalTesting.meta b/Runtime/Core/GameLiftLocalTesting.meta new file mode 100644 index 00000000..e7b0c47d --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: e57aeec191575474fa7883787ae8662f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/GameLiftProcess.cs b/Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/GameLiftProcess.cs rename to Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs diff --git a/Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs.meta b/Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs.meta new file mode 100644 index 00000000..0bdb2b4e --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/GameLiftProcess.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ffc012c37685fc4488970944984cb37b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/IGameLiftProcess.cs b/Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/IGameLiftProcess.cs rename to Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs diff --git a/Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs.meta b/Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs.meta new file mode 100644 index 00000000..b761eecf --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/IGameLiftProcess.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c7e3798eba72e784ca50f14c23409410 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/GameLiftLocalTesting/Models.meta b/Runtime/Core/GameLiftLocalTesting/Models.meta new file mode 100644 index 00000000..8dba473b --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: d58f41ffc30640f4a96807814b3b97c7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/RunLocalServer.cs b/Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/RunLocalServer.cs rename to Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs diff --git a/Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs.meta b/Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs.meta new file mode 100644 index 00000000..8ab1f910 --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/Models/RunLocalServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 66c71d84f0f092142a9b68f8c73018b4 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/Start.cs b/Runtime/Core/GameLiftLocalTesting/Models/Start.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/Start.cs rename to Runtime/Core/GameLiftLocalTesting/Models/Start.cs diff --git a/Runtime/Core/GameLiftLocalTesting/Models/Start.cs.meta b/Runtime/Core/GameLiftLocalTesting/Models/Start.cs.meta new file mode 100644 index 00000000..208f453d --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/Models/Start.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ded3a864819c7074d95887ad0bb9779a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/Stop.cs b/Runtime/Core/GameLiftLocalTesting/Models/Stop.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/GameLiftLocalTesting/Models/Stop.cs rename to Runtime/Core/GameLiftLocalTesting/Models/Stop.cs diff --git a/Runtime/Core/GameLiftLocalTesting/Models/Stop.cs.meta b/Runtime/Core/GameLiftLocalTesting/Models/Stop.cs.meta new file mode 100644 index 00000000..315e9689 --- /dev/null +++ b/Runtime/Core/GameLiftLocalTesting/Models/Stop.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d78ee7f42388d4349abdb3555944d4e3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/InstalledJavaVersionCheck.meta b/Runtime/Core/InstalledJavaVersionCheck.meta new file mode 100644 index 00000000..1254fe4e --- /dev/null +++ b/Runtime/Core/InstalledJavaVersionCheck.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 131189aeb00b95345a4ac61d8a3f219a +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs b/Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs rename to Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs diff --git a/Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs.meta b/Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs.meta new file mode 100644 index 00000000..77a89c11 --- /dev/null +++ b/Runtime/Core/InstalledJavaVersionCheck/IInstalledJavaVersionProvider.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 40c98c10cf33c954ebcce86e90390ca8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs b/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs rename to Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs diff --git a/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs.meta b/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs.meta new file mode 100644 index 00000000..63b35f6f --- /dev/null +++ b/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProvider.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 440de4ccf29c08d47b9d19d91a213818 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/InstalledJavaVersionCheck/Models.meta b/Runtime/Core/InstalledJavaVersionCheck/Models.meta new file mode 100644 index 00000000..de7f6bc1 --- /dev/null +++ b/Runtime/Core/InstalledJavaVersionCheck/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 6f1b2e10825362146966beb72e5fcca6 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs b/Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs rename to Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs diff --git a/Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs.meta b/Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs.meta new file mode 100644 index 00000000..bbf463b2 --- /dev/null +++ b/Runtime/Core/InstalledJavaVersionCheck/Models/CheckInstalledJavaVersionRequest.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0b8ee71c669f704439275c264180f969 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Latency.meta b/Runtime/Core/Latency.meta new file mode 100644 index 00000000..303d3bc7 --- /dev/null +++ b/Runtime/Core/Latency.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: f0d04cc1f9f4cc44f959a91e4695b92d +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/ILatencyService.cs b/Runtime/Core/Latency/ILatencyService.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/ILatencyService.cs rename to Runtime/Core/Latency/ILatencyService.cs diff --git a/Runtime/Core/Latency/ILatencyService.cs.meta b/Runtime/Core/Latency/ILatencyService.cs.meta new file mode 100644 index 00000000..7c4aab91 --- /dev/null +++ b/Runtime/Core/Latency/ILatencyService.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 02ba1984d76ce0a4186dd72e9bedd280 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/IPingWrapper.cs b/Runtime/Core/Latency/IPingWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/IPingWrapper.cs rename to Runtime/Core/Latency/IPingWrapper.cs diff --git a/Runtime/Core/Latency/IPingWrapper.cs.meta b/Runtime/Core/Latency/IPingWrapper.cs.meta new file mode 100644 index 00000000..caff3c5b --- /dev/null +++ b/Runtime/Core/Latency/IPingWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f380646eefd44a244b138a03b8d0b5fe +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/LatencyService.cs b/Runtime/Core/Latency/LatencyService.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/LatencyService.cs rename to Runtime/Core/Latency/LatencyService.cs diff --git a/Runtime/Core/Latency/LatencyService.cs.meta b/Runtime/Core/Latency/LatencyService.cs.meta new file mode 100644 index 00000000..a43e9f83 --- /dev/null +++ b/Runtime/Core/Latency/LatencyService.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 47601b07da5090a4db8450ff6aa415f1 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Latency/Models.meta b/Runtime/Core/Latency/Models.meta new file mode 100644 index 00000000..b43fc718 --- /dev/null +++ b/Runtime/Core/Latency/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 17c40c1eae560e14bb7640c8632c63fb +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/Models/GetLatencies.cs b/Runtime/Core/Latency/Models/GetLatencies.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/Models/GetLatencies.cs rename to Runtime/Core/Latency/Models/GetLatencies.cs diff --git a/Runtime/Core/Latency/Models/GetLatencies.cs.meta b/Runtime/Core/Latency/Models/GetLatencies.cs.meta new file mode 100644 index 00000000..7732d6f9 --- /dev/null +++ b/Runtime/Core/Latency/Models/GetLatencies.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 01f40501ca14bd54f9808df44eb7e2c5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/Models/PingResult.cs b/Runtime/Core/Latency/Models/PingResult.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/Models/PingResult.cs rename to Runtime/Core/Latency/Models/PingResult.cs diff --git a/Runtime/Core/Latency/Models/PingResult.cs.meta b/Runtime/Core/Latency/Models/PingResult.cs.meta new file mode 100644 index 00000000..0a1f9225 --- /dev/null +++ b/Runtime/Core/Latency/Models/PingResult.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 97ec5f2095ecbc643ad825ac9cc55cba +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/PingWrapper.cs b/Runtime/Core/Latency/PingWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Latency/PingWrapper.cs rename to Runtime/Core/Latency/PingWrapper.cs diff --git a/Runtime/Core/Latency/PingWrapper.cs.meta b/Runtime/Core/Latency/PingWrapper.cs.meta new file mode 100644 index 00000000..b386b308 --- /dev/null +++ b/Runtime/Core/Latency/PingWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cae5184475b573d4b9990e1832d8afc8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins.meta b/Runtime/Core/Plugins.meta similarity index 77% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins.meta rename to Runtime/Core/Plugins.meta index 4c0a2cd3..d5a25e0b 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins.meta +++ b/Runtime/Core/Plugins.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 8550bbba497428c42947b6ec406dd6a1 +guid: 679b4151296991c42b3d4e08a92f5192 folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/Runtime/Core/Plugins/AWSSDK.CloudFormation.dll.meta b/Runtime/Core/Plugins/AWSSDK.CloudFormation.dll.meta new file mode 100644 index 00000000..6dc0178a --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.CloudFormation.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: b95735d86a47127469bf87044ab66b9b +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta b/Runtime/Core/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta new file mode 100644 index 00000000..f52f42bd --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.CognitoIdentityProvider.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 638c1e92bef5beb4c9b254fde6095694 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/AWSSDK.Core.dll.meta b/Runtime/Core/Plugins/AWSSDK.Core.dll.meta new file mode 100644 index 00000000..43536928 --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.Core.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 988c6dac8be203c42b6e4057925970c8 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/AWSSDK.GameLift.dll.meta b/Runtime/Core/Plugins/AWSSDK.GameLift.dll.meta new file mode 100644 index 00000000..30edaccb --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.GameLift.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 24e2be80f02d5194b958c8f6782c4d63 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/AWSSDK.S3.dll.meta b/Runtime/Core/Plugins/AWSSDK.S3.dll.meta new file mode 100644 index 00000000..20ea25f2 --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.S3.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: ccb479225beabf84fb42374e745cda52 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/AWSSDK.SecurityToken.dll.meta b/Runtime/Core/Plugins/AWSSDK.SecurityToken.dll.meta new file mode 100644 index 00000000..df455fc9 --- /dev/null +++ b/Runtime/Core/Plugins/AWSSDK.SecurityToken.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 454044b30bd1833488e66ba8034e5225 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Castle.Core.dll.meta b/Runtime/Core/Plugins/Castle.Core.dll.meta new file mode 100644 index 00000000..3ca0f160 --- /dev/null +++ b/Runtime/Core/Plugins/Castle.Core.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: af6600edd4066ce4f91d989a1660a130 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta b/Runtime/Core/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta new file mode 100644 index 00000000..e439a060 --- /dev/null +++ b/Runtime/Core/Plugins/Microsoft.IdentityModel.JsonWebTokens.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 53ea6dc7409252b4a80bbe065f66e770 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Microsoft.IdentityModel.Logging.dll.meta b/Runtime/Core/Plugins/Microsoft.IdentityModel.Logging.dll.meta new file mode 100644 index 00000000..7b02ab14 --- /dev/null +++ b/Runtime/Core/Plugins/Microsoft.IdentityModel.Logging.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: ddd6785ee6a17dc49842f3163af253a2 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Microsoft.IdentityModel.Tokens.dll.meta b/Runtime/Core/Plugins/Microsoft.IdentityModel.Tokens.dll.meta new file mode 100644 index 00000000..308b552d --- /dev/null +++ b/Runtime/Core/Plugins/Microsoft.IdentityModel.Tokens.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 78740ebab8d6afa4bb91a83e11c8415c +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Moq.dll.meta b/Runtime/Core/Plugins/Moq.dll.meta new file mode 100644 index 00000000..d47a7c10 --- /dev/null +++ b/Runtime/Core/Plugins/Moq.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: cf204c6f3dc53404388febe733269a6c +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Serilog.Sinks.File.dll.meta b/Runtime/Core/Plugins/Serilog.Sinks.File.dll.meta new file mode 100644 index 00000000..5f7bf848 --- /dev/null +++ b/Runtime/Core/Plugins/Serilog.Sinks.File.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 89c014955f573554280eb6e437fba4cb +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/Serilog.dll.meta b/Runtime/Core/Plugins/Serilog.dll.meta new file mode 100644 index 00000000..5518f8c7 --- /dev/null +++ b/Runtime/Core/Plugins/Serilog.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 28f85bbd85482b64f8bffd199a71ad2d +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta b/Runtime/Core/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta new file mode 100644 index 00000000..6b7f5353 --- /dev/null +++ b/Runtime/Core/Plugins/System.IdentityModel.Tokens.Jwt.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 041578ab638ab2f48902f2e74a862891 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/System.Threading.Tasks.Extensions.dll.meta b/Runtime/Core/Plugins/System.Threading.Tasks.Extensions.dll.meta new file mode 100644 index 00000000..6d65b622 --- /dev/null +++ b/Runtime/Core/Plugins/System.Threading.Tasks.Extensions.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 49d8a5d83371b97439410ae053b554fa +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Plugins/YamlDotNet.dll.meta b/Runtime/Core/Plugins/YamlDotNet.dll.meta new file mode 100644 index 00000000..663e62d0 --- /dev/null +++ b/Runtime/Core/Plugins/YamlDotNet.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: a3ac80cb038903b4facacfed61752214 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/README.md b/Runtime/Core/README.md new file mode 100644 index 00000000..8b01be95 --- /dev/null +++ b/Runtime/Core/README.md @@ -0,0 +1,4 @@ + + +### csc.rsp +This is used to reference System.IO.Compression.FileSystem to get ZipFile.cs to be recognized, see reference: https://forum.unity.com/threads/difficulty-getting-msc-rsp-working.640303/ \ No newline at end of file diff --git a/Runtime/Core/README.md.meta b/Runtime/Core/README.md.meta new file mode 100644 index 00000000..e333481b --- /dev/null +++ b/Runtime/Core/README.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 852d2d7dfc965bb439793fe3cdf246c1 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/SettingsManagement.meta b/Runtime/Core/SettingsManagement.meta new file mode 100644 index 00000000..8cfb3581 --- /dev/null +++ b/Runtime/Core/SettingsManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a5fe6f3b690e8c7419e732025c0a3155 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/ISettingsStore.cs b/Runtime/Core/SettingsManagement/ISettingsStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/ISettingsStore.cs rename to Runtime/Core/SettingsManagement/ISettingsStore.cs diff --git a/Runtime/Core/SettingsManagement/ISettingsStore.cs.meta b/Runtime/Core/SettingsManagement/ISettingsStore.cs.meta new file mode 100644 index 00000000..d7b8cb0e --- /dev/null +++ b/Runtime/Core/SettingsManagement/ISettingsStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ded447abd645cff4b871ef260642de88 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/SettingsManagement/Models.meta b/Runtime/Core/SettingsManagement/Models.meta new file mode 100644 index 00000000..48866c0f --- /dev/null +++ b/Runtime/Core/SettingsManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: e4d41fcf36979f945b5d0a7cd8029bb4 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/ClearSetting.cs b/Runtime/Core/SettingsManagement/Models/ClearSetting.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/ClearSetting.cs rename to Runtime/Core/SettingsManagement/Models/ClearSetting.cs diff --git a/Runtime/Core/SettingsManagement/Models/ClearSetting.cs.meta b/Runtime/Core/SettingsManagement/Models/ClearSetting.cs.meta new file mode 100644 index 00000000..b93d333a --- /dev/null +++ b/Runtime/Core/SettingsManagement/Models/ClearSetting.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 758405c702b9faf4d938398acb422cfc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/GetSetting.cs b/Runtime/Core/SettingsManagement/Models/GetSetting.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/GetSetting.cs rename to Runtime/Core/SettingsManagement/Models/GetSetting.cs diff --git a/Runtime/Core/SettingsManagement/Models/GetSetting.cs.meta b/Runtime/Core/SettingsManagement/Models/GetSetting.cs.meta new file mode 100644 index 00000000..ce847b4e --- /dev/null +++ b/Runtime/Core/SettingsManagement/Models/GetSetting.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7154ae706d30e784a9627b68474687a0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/PutSetting.cs b/Runtime/Core/SettingsManagement/Models/PutSetting.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/Models/PutSetting.cs rename to Runtime/Core/SettingsManagement/Models/PutSetting.cs diff --git a/Runtime/Core/SettingsManagement/Models/PutSetting.cs.meta b/Runtime/Core/SettingsManagement/Models/PutSetting.cs.meta new file mode 100644 index 00000000..7792ad07 --- /dev/null +++ b/Runtime/Core/SettingsManagement/Models/PutSetting.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b037158a1aa80114f9716a84fcf900f5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/SettingsStore.cs b/Runtime/Core/SettingsManagement/SettingsStore.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/SettingsManagement/SettingsStore.cs rename to Runtime/Core/SettingsManagement/SettingsStore.cs diff --git a/Runtime/Core/SettingsManagement/SettingsStore.cs.meta b/Runtime/Core/SettingsManagement/SettingsStore.cs.meta new file mode 100644 index 00000000..3da8374a --- /dev/null +++ b/Runtime/Core/SettingsManagement/SettingsStore.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9fe68dcf50a44d149ba4372ece6902d4 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared.meta b/Runtime/Core/Shared.meta new file mode 100644 index 00000000..1d2d12e7 --- /dev/null +++ b/Runtime/Core/Shared.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 0687bfb5302d89642a8a0664b8411f5f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/AwsRegionMapper.cs b/Runtime/Core/Shared/AwsRegionMapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/AwsRegionMapper.cs rename to Runtime/Core/Shared/AwsRegionMapper.cs diff --git a/Runtime/Core/Shared/AwsRegionMapper.cs.meta b/Runtime/Core/Shared/AwsRegionMapper.cs.meta new file mode 100644 index 00000000..d059099c --- /dev/null +++ b/Runtime/Core/Shared/AwsRegionMapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 61977b47c0d878745bd1745f1170181e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Bootstrapper.cs b/Runtime/Core/Shared/Bootstrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Bootstrapper.cs rename to Runtime/Core/Shared/Bootstrapper.cs diff --git a/Runtime/Core/Shared/Bootstrapper.cs.meta b/Runtime/Core/Shared/Bootstrapper.cs.meta new file mode 100644 index 00000000..3f266c37 --- /dev/null +++ b/Runtime/Core/Shared/Bootstrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: abfebac6258550b4ca800517ab12abe0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ErrorCode.cs b/Runtime/Core/Shared/ErrorCode.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ErrorCode.cs rename to Runtime/Core/Shared/ErrorCode.cs diff --git a/Runtime/Core/Shared/ErrorCode.cs.meta b/Runtime/Core/Shared/ErrorCode.cs.meta new file mode 100644 index 00000000..81c59217 --- /dev/null +++ b/Runtime/Core/Shared/ErrorCode.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 93ba156a60568bb43842c93b068c375c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/FileSystem.meta b/Runtime/Core/Shared/FileSystem.meta new file mode 100644 index 00000000..ab2ac304 --- /dev/null +++ b/Runtime/Core/Shared/FileSystem.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 570cc1e2934a41c458eaf596627fb786 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileSystem/FileWrapper.cs b/Runtime/Core/Shared/FileSystem/FileWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileSystem/FileWrapper.cs rename to Runtime/Core/Shared/FileSystem/FileWrapper.cs diff --git a/Runtime/Core/Shared/FileSystem/FileWrapper.cs.meta b/Runtime/Core/Shared/FileSystem/FileWrapper.cs.meta new file mode 100644 index 00000000..63a05dbc --- /dev/null +++ b/Runtime/Core/Shared/FileSystem/FileWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ab3535d54eddae64a8d56e74a37abaea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileSystem/IFileWrapper.cs b/Runtime/Core/Shared/FileSystem/IFileWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileSystem/IFileWrapper.cs rename to Runtime/Core/Shared/FileSystem/IFileWrapper.cs diff --git a/Runtime/Core/Shared/FileSystem/IFileWrapper.cs.meta b/Runtime/Core/Shared/FileSystem/IFileWrapper.cs.meta new file mode 100644 index 00000000..c3092862 --- /dev/null +++ b/Runtime/Core/Shared/FileSystem/IFileWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f33efaa862dcd814ab21b2931f55b652 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/FileZip.meta b/Runtime/Core/Shared/FileZip.meta new file mode 100644 index 00000000..85467846 --- /dev/null +++ b/Runtime/Core/Shared/FileZip.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 8c52dc3f86192974987c5015b707125e +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileZip/FileZip.cs b/Runtime/Core/Shared/FileZip/FileZip.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileZip/FileZip.cs rename to Runtime/Core/Shared/FileZip/FileZip.cs diff --git a/Runtime/Core/Shared/FileZip/FileZip.cs.meta b/Runtime/Core/Shared/FileZip/FileZip.cs.meta new file mode 100644 index 00000000..60646c63 --- /dev/null +++ b/Runtime/Core/Shared/FileZip/FileZip.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 461de542c8f8c524c8b50795122cd4c9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileZip/IFileZip.cs b/Runtime/Core/Shared/FileZip/IFileZip.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/FileZip/IFileZip.cs rename to Runtime/Core/Shared/FileZip/IFileZip.cs diff --git a/Runtime/Core/Shared/FileZip/IFileZip.cs.meta b/Runtime/Core/Shared/FileZip/IFileZip.cs.meta new file mode 100644 index 00000000..53adcca0 --- /dev/null +++ b/Runtime/Core/Shared/FileZip/IFileZip.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: de52f686abbf2dd44a00618964c4a37f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/Logging.meta b/Runtime/Core/Shared/Logging.meta new file mode 100644 index 00000000..9b9e5cc9 --- /dev/null +++ b/Runtime/Core/Shared/Logging.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a3834a6552e754c438624899f5d98387 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Logging/Logger.cs b/Runtime/Core/Shared/Logging/Logger.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Logging/Logger.cs rename to Runtime/Core/Shared/Logging/Logger.cs diff --git a/Runtime/Core/Shared/Logging/Logger.cs.meta b/Runtime/Core/Shared/Logging/Logger.cs.meta new file mode 100644 index 00000000..baa954fa --- /dev/null +++ b/Runtime/Core/Shared/Logging/Logger.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b35948ede7870eb4c967af5dcb6b92d5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/ProcessManagement.meta b/Runtime/Core/Shared/ProcessManagement.meta new file mode 100644 index 00000000..91957d17 --- /dev/null +++ b/Runtime/Core/Shared/ProcessManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 8c77a38ca0976a74a9cf4e92ec96dbeb +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/ExecutableNotFoundException.cs b/Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/ExecutableNotFoundException.cs rename to Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs diff --git a/Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs.meta b/Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs.meta new file mode 100644 index 00000000..7c39290b --- /dev/null +++ b/Runtime/Core/Shared/ProcessManagement/ExecutableNotFoundException.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9a7849fe77fce454593e76616074bc67 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/IProcessWrapper.cs b/Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/IProcessWrapper.cs rename to Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs diff --git a/Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs.meta b/Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs.meta new file mode 100644 index 00000000..c645bcd2 --- /dev/null +++ b/Runtime/Core/Shared/ProcessManagement/IProcessWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3cbdf5566fba9ab4b9d63f9eed29e0dd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/ProcessWrapper.cs b/Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ProcessManagement/ProcessWrapper.cs rename to Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs diff --git a/Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs.meta b/Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs.meta new file mode 100644 index 00000000..590cd4db --- /dev/null +++ b/Runtime/Core/Shared/ProcessManagement/ProcessWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4eee40d1271a65744a9867c9eb9cc8fb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Response.cs b/Runtime/Core/Shared/Response.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/Response.cs rename to Runtime/Core/Shared/Response.cs diff --git a/Runtime/Core/Shared/Response.cs.meta b/Runtime/Core/Shared/Response.cs.meta new file mode 100644 index 00000000..219a3ac1 --- /dev/null +++ b/Runtime/Core/Shared/Response.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 00451191ea668f64a905495af563e70e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/S3Bucket.meta b/Runtime/Core/Shared/S3Bucket.meta new file mode 100644 index 00000000..14a3753b --- /dev/null +++ b/Runtime/Core/Shared/S3Bucket.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 804dd2c3d2713064f808a9571bddf046 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/S3Bucket/AmazonS3Wrapper.cs b/Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/S3Bucket/AmazonS3Wrapper.cs rename to Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs diff --git a/Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs.meta b/Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs.meta new file mode 100644 index 00000000..f91bfa2b --- /dev/null +++ b/Runtime/Core/Shared/S3Bucket/AmazonS3Wrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 56342b3221a68a14ea79e15aa8dcd136 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/S3Bucket/IAmazonS3Wrapper.cs b/Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/S3Bucket/IAmazonS3Wrapper.cs rename to Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs diff --git a/Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs.meta b/Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs.meta new file mode 100644 index 00000000..ef20a061 --- /dev/null +++ b/Runtime/Core/Shared/S3Bucket/IAmazonS3Wrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 69bdf88eeb83f404aa629e117eaf17be +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/Shared/SettingsStore.meta b/Runtime/Core/Shared/SettingsStore.meta new file mode 100644 index 00000000..378c7868 --- /dev/null +++ b/Runtime/Core/Shared/SettingsStore.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 4884cd09d81735640b8538f59ee012a8 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/SettingsStore/IStreamWrapper.cs b/Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/SettingsStore/IStreamWrapper.cs rename to Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs diff --git a/Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs.meta b/Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs.meta new file mode 100644 index 00000000..36d4e686 --- /dev/null +++ b/Runtime/Core/Shared/SettingsStore/IStreamWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a3006009648784a4a9e942de50f629ef +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/SettingsStore/YamlStreamWrapper.cs b/Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/SettingsStore/YamlStreamWrapper.cs rename to Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs diff --git a/Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs.meta b/Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs.meta new file mode 100644 index 00000000..d2075d0d --- /dev/null +++ b/Runtime/Core/Shared/SettingsStore/YamlStreamWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2538b6b29c9b9c8418a9d893e049e6f7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ValidationResult.cs b/Runtime/Core/Shared/ValidationResult.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/Shared/ValidationResult.cs rename to Runtime/Core/Shared/ValidationResult.cs diff --git a/Runtime/Core/Shared/ValidationResult.cs.meta b/Runtime/Core/Shared/ValidationResult.cs.meta new file mode 100644 index 00000000..e7a8f9a4 --- /dev/null +++ b/Runtime/Core/Shared/ValidationResult.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f92f019bd4c55574d8ee86c52246b6ab +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/UserIdentityManagement.meta b/Runtime/Core/UserIdentityManagement.meta new file mode 100644 index 00000000..9c38efa5 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a3561210571557d48bc8f0066fea77d9 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs b/Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs rename to Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs diff --git a/Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs.meta b/Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs.meta new file mode 100644 index 00000000..28b6d256 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/AmazonCognitoIdentityWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e53b330f509d2f7408d71a0185d6a4ce +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs b/Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs rename to Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs diff --git a/Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs.meta b/Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs.meta new file mode 100644 index 00000000..9c7d8cbd --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/IAmazonCognitoIdentityWrapper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a555d1066574cfa4d9ae57c8ed3ea78b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/IUserIdentity.cs b/Runtime/Core/UserIdentityManagement/IUserIdentity.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/IUserIdentity.cs rename to Runtime/Core/UserIdentityManagement/IUserIdentity.cs diff --git a/Runtime/Core/UserIdentityManagement/IUserIdentity.cs.meta b/Runtime/Core/UserIdentityManagement/IUserIdentity.cs.meta new file mode 100644 index 00000000..18b78a3b --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/IUserIdentity.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 871e734e6fb8b75418245604583bc98e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/UserIdentityManagement/Models.meta b/Runtime/Core/UserIdentityManagement/Models.meta new file mode 100644 index 00000000..3a6c3726 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/Models.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 9ca95d475ca196441928638e9bc0ea5a +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/ConfirmSignUp.cs b/Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/ConfirmSignUp.cs rename to Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit.meta b/Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs.meta similarity index 56% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit.meta rename to Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs.meta index 32dedf8f..0f0d399a 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit.meta +++ b/Runtime/Core/UserIdentityManagement/Models/ConfirmSignUp.cs.meta @@ -1,8 +1,11 @@ fileFormatVersion: 2 -guid: 750d584fb9602aa4aa598ea46689ff0a -folderAsset: yes -DefaultImporter: +guid: ae20b64d852568740b2d5145f9873a80 +MonoImporter: externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} userData: assetBundleName: assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/RefreshToken.cs b/Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/RefreshToken.cs rename to Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs diff --git a/Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs.meta b/Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs.meta new file mode 100644 index 00000000..d3634976 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/Models/RefreshToken.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0a98866d9a5c2a941ba1527ea95f82aa +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignIn.cs b/Runtime/Core/UserIdentityManagement/Models/SignIn.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignIn.cs rename to Runtime/Core/UserIdentityManagement/Models/SignIn.cs diff --git a/Runtime/Core/UserIdentityManagement/Models/SignIn.cs.meta b/Runtime/Core/UserIdentityManagement/Models/SignIn.cs.meta new file mode 100644 index 00000000..b37e84f9 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/Models/SignIn.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 69aa78d5198aad849be9a2ab8d78a5c2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignOut.cs b/Runtime/Core/UserIdentityManagement/Models/SignOut.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignOut.cs rename to Runtime/Core/UserIdentityManagement/Models/SignOut.cs diff --git a/Runtime/Core/UserIdentityManagement/Models/SignOut.cs.meta b/Runtime/Core/UserIdentityManagement/Models/SignOut.cs.meta new file mode 100644 index 00000000..7ff65d9e --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/Models/SignOut.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b6a851f895b8dc3489a138d32b2c8b28 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignUp.cs b/Runtime/Core/UserIdentityManagement/Models/SignUp.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/Models/SignUp.cs rename to Runtime/Core/UserIdentityManagement/Models/SignUp.cs diff --git a/Runtime/Core/UserIdentityManagement/Models/SignUp.cs.meta b/Runtime/Core/UserIdentityManagement/Models/SignUp.cs.meta new file mode 100644 index 00000000..c3c49196 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/Models/SignUp.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 73a4e24ccba1cb34a877113d9052a3a6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/UserIdentity.cs b/Runtime/Core/UserIdentityManagement/UserIdentity.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core/UserIdentityManagement/UserIdentity.cs rename to Runtime/Core/UserIdentityManagement/UserIdentity.cs diff --git a/Runtime/Core/UserIdentityManagement/UserIdentity.cs.meta b/Runtime/Core/UserIdentityManagement/UserIdentity.cs.meta new file mode 100644 index 00000000..cc6db230 --- /dev/null +++ b/Runtime/Core/UserIdentityManagement/UserIdentity.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f10d3e6e2d0778c4a99b6868e0d9e67e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Core/csc.rsp b/Runtime/Core/csc.rsp new file mode 100644 index 00000000..bfb044b0 --- /dev/null +++ b/Runtime/Core/csc.rsp @@ -0,0 +1 @@ +-r:System.IO.Compression.FileSystem.dll \ No newline at end of file diff --git a/Runtime/Core/csc.rsp.meta b/Runtime/Core/csc.rsp.meta new file mode 100644 index 00000000..215227e1 --- /dev/null +++ b/Runtime/Core/csc.rsp.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 665668f4394e49c45bec8d769dd46e51 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftClientSettings.cs b/Runtime/GameLiftClientSettings.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftClientSettings.cs rename to Runtime/GameLiftClientSettings.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftClientSettings.cs.meta b/Runtime/GameLiftClientSettings.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftClientSettings.cs.meta rename to Runtime/GameLiftClientSettings.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftConfiguration.cs b/Runtime/GameLiftConfiguration.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftConfiguration.cs rename to Runtime/GameLiftConfiguration.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftConfiguration.cs.meta b/Runtime/GameLiftConfiguration.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftConfiguration.cs.meta rename to Runtime/GameLiftConfiguration.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftCoreApi.cs b/Runtime/GameLiftCoreApi.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftCoreApi.cs rename to Runtime/GameLiftCoreApi.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftCoreApi.cs.meta b/Runtime/GameLiftCoreApi.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Scripts/GameLiftCoreApi.cs.meta rename to Runtime/GameLiftCoreApi.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins.meta b/Runtime/Plugins.meta similarity index 77% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins.meta rename to Runtime/Plugins.meta index a8832a1b..95f23348 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Plugins.meta +++ b/Runtime/Plugins.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: cb4761e52db2686449aa1c774f745bb9 +guid: dd96fe4b126e7f4478ba32b5d0f3014b folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/Runtime/Plugins/GameLiftServerSDKNet45.dll.config b/Runtime/Plugins/GameLiftServerSDKNet45.dll.config new file mode 100644 index 00000000..99ddf3e0 --- /dev/null +++ b/Runtime/Plugins/GameLiftServerSDKNet45.dll.config @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/Runtime/Plugins/GameLiftServerSDKNet45.dll.config.meta b/Runtime/Plugins/GameLiftServerSDKNet45.dll.config.meta new file mode 100644 index 00000000..af114bff --- /dev/null +++ b/Runtime/Plugins/GameLiftServerSDKNet45.dll.config.meta @@ -0,0 +1,32 @@ +fileFormatVersion: 2 +guid: d9b5e79df56ada9468994ea0406e9ec3 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 0 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 1 + settings: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Plugins/GameLiftServerSDKNet45.dll.meta b/Runtime/Plugins/GameLiftServerSDKNet45.dll.meta new file mode 100644 index 00000000..d56dc715 --- /dev/null +++ b/Runtime/Plugins/GameLiftServerSDKNet45.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 0385ffa1cdc4e0c479dd4f5f9251fd88 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Plugins/Google.Protobuf.dll.meta b/Runtime/Plugins/Google.Protobuf.dll.meta new file mode 100644 index 00000000..fd45e6bf --- /dev/null +++ b/Runtime/Plugins/Google.Protobuf.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 8e70ab12ff7f0fc458442b857ba8672f +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Runtime/Plugins/Google.Protobuf.pdb b/Runtime/Plugins/Google.Protobuf.pdb new file mode 100644 index 0000000000000000000000000000000000000000..41d7cac619c2a27252d6a8e2ddde1092141df6d1 GIT binary patch literal 138644 zcmcHiWtbMn_Jt2O3^2^#?(XjH?!nz%f(LgA5Zv7fuE7&rf+a|T#vmaff`lLuB!vH7 zi<&v>SG?CNAKvFWeN%Vss_O1t)$$CSNyUaWD@F;T1o*_ZtzPAd=?4|ao1Yayj9`Qn z#@LprUZ)PI``5Nraiav8Mg_sLcu|5eF)h|`K>zN&yS|5b>f}*^X!d8O#tnn?R<4I~ zwZ=6n+n;^SGe@_+6?^ufZChaENIfRLF+#nj7u}gs)MF0*W?OI8}O)> zn`g7byKRFOh!q5RLW3Z?`785Q_UFs!Z`yrl?FQJkEousNYMNe%KeNXL4_|+Zf*<-jS% zndOlz2j8MTxiKU-!}9kmU$=|Rt|_BkBR`-#z!(zLxs7sXV~AbfF{0oqFK&z)WZ)H> zoh(6?C##X~kd4XKWM{IM@y*9F!I}l+M)D)_WAYezmi&VJiu{56jeJBF48ie~BrB5L z$$sQ0aw@sV7!rg;1LKkT$ueY3aum6V+)17!KPRt{-;zI(_sOT^OEQk#EA8$=Rv|wp zQ^r7jck(#-fc%sEmyBlj-H;$QnV3vXRwE~p8_2Wd7vxvu59Dv;Bk~y;#Kf4%$ok|| z@)Y@+3=Kn@PUH%5JsB2``buOi@)FtF?%5&1F|t5xl;0;`lc8}?6OSxM_8>=)bIGM- z)VOGwn9LdvKQCzG?u#pG&o6SS%#cUo+Cq&AljK6K~5$Ykax+)qtMRp{6ki*H@)aB4lZ@5?Pb1Pc|dll3mF@j*@;>>L zd_hLZj5aaJcw{m%Et!?fOBNx^kX4QGf{El6GDa5E#3j>{1<7V)XL2nWWJSxm

rt z`6n4AJEEJ(d0mOMt5%7&e~ZW%3o7y*S2cNRBcl32ui z%Vdu-C{HDKl1IqT$*;(t$tT7XLA|nId$JojjoeGdDu-xEvJW|td`;#mk7#3Z5V_2l zGWdi1n|x(V6}(pg97awh=a5UtHRLDcHS#9;Gx>ykL55buIPu7GWDl}GxrV$zJ~O5c zI#&XFk|W8<$zJ3@auIofyhh$6?~zZ)*JNmQ zjFXs5P39mAkY&lL&-lJ6SR2CIzedF1JXn=C&h z|04e-L+YVTJTg6*jm%5dAls5%$id`vaxM9ZF$4FKA$Y-Ztoo=)M5ZD$kwwVbWFxW_ z*@>J&t|zyXr^wsnD`UoBU;}VBd4N1lo+YC+L^O=7M!rwZCXbO9$kdI{GBa6=97awu zW(ejPGx3Zv1>dv$i2R5AkBr_JZIY6?$wFjFvMO1J>`%@i7n29bZ^?hj^i6^wGxwM| zXv=bcaws{5oJ1}rcaZzY!{jOQJ{j5+qs1e$k`>7|?jVno=g2(Gv6l(tbn-b_y9MfZ8?yuhT7qN9N#qQ2 zKDpYMIoL+-B@dIQ$P45TIO4N{%Hble5Vca53(;UG@mJgCA$aCZu_+w_N0JlBIph*@1G$6TPku_CC%-0dlkGd>7``QcBFA+>%`>uh zSCk)+FUgQ@sEI`;A`6hM$WCNWaws{LoJ`IpSCH$;-Q+qlBg7|@lj+G8

rad4~Ll%+?dV+LFD=LF6cMBDsj% zLmnbOCBG!UCVwFxl4*Nk%o=2UaxA%(yiKO)9RxYKwsQt8Snfp*AcvFV$Qk5XatpbO zJVKr#ACR&8V9dm15wZz6m|RM(Avcq|$OGgV@)r3E`H*}`hV;eAxyagNBXS_QfZR`h zOa4UOC!dlp$(a2xPC7ChnU5?@RwjFpQ^~pH9`YLbH<_|O#>q(LBny%y$!cU9vJ2Up z98QiWH<6!{SI9rfB=2G5qGSuQ1KES@PYxp|kt@jc^qh+9EJd~=N0O_Jxq|4!z@%gvGBcTrEJ&6h z%ahf~dSo-Q9odcSOAaB&kROoWkt2r(L2lj?atB9QzDj;a-XR~5ugRn%&^|4hmCQ>v zBKwj<$eH98@(g*Od_hJXiE+Zogk&{xKDnG+NA4mIkY~tCD7hdfT6Bd?RU$Y02Zf~86)%)m` zi5yN|By&wb{T}i$`J9Y05%pnY0x~mMo~%yRBb$*QklV?9>EIET*POc-jk$cG#WULP`W+E~bnVrl}mLcns?aA)sAo2rp3Au*cK^`Zskl&KO zk&nn%Wc10{Z$dI9nT^axmL@Bc^~vUB7jg(Wg`7jKBsY+I$V22g@=Nj-`3w1!d`S+U zf+P8dd`)hgikeK*z)fVq=_vOg`;)`SapX*L3%Q#-NS-CXAa9aClTXMOWatcx9FHtV z_8|L{Ysd>^)R|~mlB`bFBb$-!$kF6xau<1kJVRb0za#IE56I_alvx-*E}4`}OJ*ep zklV?9dI+358id5-*zd_+DYgE?puhb%;vA}f*g$Yx|`axgiWoK3DE*OR-+gXCHA z3o?8z_EL_lMouITk}t^8^U$U)*_3Qcb|r_AOUVz(E#$}KG4cX=jl47|XH8L}V7S7+H?2O|~KXl0(P| z2xsyCXo+hu5-;%$PkH}YK^cC1|LNXwAivNt)L98b<77m@48 zZR7#+1bK`91l7d`X6UgfU~0iO5uBKC%VbfgC_iBxjII$!+9O@(g*E z{EoasX5WdubR^#;H8FddvC`h&@XOWA@Rpdr;FL{{!jJ!eKC!dlp$&kGmGZvYa ztW4G>+mL<9A>;&dIys-bLyWFfL7*@&EO%oqGXRy=`nPjVmm zm@IV?_07mG(rAy1L#$t&bH zq+}Xnkzg=6ja*G`BzKVe zj75X$XTdgPXXD$SV!>9cFBa@350J;n?KVfng3BytIfrs?vM{-n{E*y2?j}!>7szYm zP4W>L^)rlkXy;KWReSLlZMPf<{^ua zWymUI9kMamn(R#WA_tNq$qD36@)nu(BKFdj>_rYFN0F1r*q6{IF`1goOco$Z7)t~b z$?4=gaw)ln+(dpv?kA6s56Kr~j4v=wLgW9hpOQgu>s2xsPEI4|8cPKa$ckU0+>abW z&Lx+U`^lr^8S)Z&gZ!TSmHdPJhkQ+jUdG7r$Yf+XG8|H$Z9 z5XH4qI>5D4I>5D4I*85sY-C=th_OuYA$ftkO8#Ih8&tgtb|HI_1IXdzIC3&MpIkf2?lgUfuZSoN`w{h%$$!acKcOZAS%z#u z_9MrWQ^`f-5%M&7k?e3MaG%;iA1l`m29u-756Syv%AXOfLUtjCkW&v6O*~fg2t#pS+a`p%_n-WG_w4rCN$V+HKD-{uRdn5&uYShBjlIl z-(=xmQD2p8Xw*-5(4O_($$sQeax6KSoJ}q!SCgB_o#ZFvaq=AbCHXaZo4iXtCZCg0 ze#23PkqO8YWCk(^S%54-Rv>E_-+aP@`mAYAwwLz9znBBSBKS=M|L zSrgIzG3%d`>F&DS+A(Lda(IxBEJl`#j7IdW7FiP>G-8`pWT(jbh?YIQnuz`UfBrK( z7!}z!JeU|+ju?4{)!4t8C)XJ5Ux1T4$s^=x@*;Vi{E2)_#<_=HNys#07P2YX))+tN zM)oB~k`u`3L-41hxPZ#C**T7xQ~5>l5vd*gCt~bvMkw_toH!X z4&;9F8QJ)E)K4aVAY(s7O?I*yIg>m_{%w5oNgTY6EGG#X{1H+A=Fe0?3$G?k(EhEO zZg17}^=i@vL%f>w!Dy?=7)&H*kPFBaV4u}z2o8JEOu;FyCUbE9t(q%u z)qLyKWD9=sYH|ek-l}>0R?YLbYN9;)zek@V2=i)k1_|D(N&Z$%`nPJbzg3g}t(xL* z)s%m$rutho^}L!~K{Kn#6}0o}a|gZNsu}oJ&B(WECcITMuOJ=w7<1A zp53vnCSH)3OigAsCJb_uWyyBr5OSt5cd(FLNp2u_kcY@0$$R9#WZZwyD=C?YEJ9Wz z>yoX=PGmoFC^?awL7pXFkF0~O@_Wi`*>tBGBa6)tV6aX`;kM*iR2=3Gr5aA zN}eJAAv6Aq@pF;fAZL)DkjKe$S+S@Ik5NAjLgKe>Y^Z`Hhbt0t=b{v7?--{8DelklyYlvab^%Mshvl)+GJM7X1^uHe(S-Ty=Cz{v-9W{54Un$+d}L+bPU%%)I6Fv;?c!p zn8y$gGY=KVm@&m;n}>-fFb@|;JeGJm^Vs5z&EuGdy5p;09#3%Zr_gV7~Y(J z9Pc%48$Dt?&^)I&@|nwXyK*A;k9Z#2B90fHR~-4kHKXzT;)oZJ z@e-RC6pv?KNW7SNVe{B7-w(xc>_eT$v3M&h*R`#PwU6uCj}$L!Wo$()9?!+cm=`lo z===}!;^K|OaV%+UD`D|Ou077br01nPFYS35&&!JAdM+p4#=N|FVz<8z<`vA7IxlWs zQ5@^Nl6f*YzRI3g@w}?%)x>c$Na*JnB(4`-L~fDMO_@{7vacH7w5$-j-q4Mg&%CpEb(_`*uWvEr2j0lq zPqFes=S|Er*tz33>>=LDyn~gIV|W|$k>-`1w>1y9u``-?v3NUkd=84YvvLdDx>~%w zi;ok>vk3Pb#5-6VW0!H>(Y&dZv)b0p-XJ=;{+N|T z&-;oevG)DUJG(rhLeCe8WBkS9IKL(0h%fbgnKOoDVgxWo6{&iuE7n`r|tTe7HHzCA;$x=4hMVwyU;{ zbnTI^Yt}x(alY_T7DsMyKJd}zxb`#JcHMl8>p#W$So0!Q#`7KVapssm%;ydB@veOZ z=kJ?iygc8;#ki=*tdm<_PBm;izEJ{IQI9Gcn$MA;@Ql97RUG1 zU&Ql><6esA*RK|z=#Cfj@tZjEc~=~L?ujFx_r)u=Bh5y$yI^ZdEzFFb$g z`M;jO5)ZTS|MUE{=RuVJ9WUBP@jR+H&L>11?|0F}F+b788<@xNJX9R(Bc?dohj|_@ zj`p!Uk1dY=aXgRfc|3897vJ*);utTXINB%jJh6CrizhLk?B*ZWe^T=);>paXI`3!k zt`jF<;@@S1>OsKF3~Q;43YT zdshMHtIRPsIh?OH$J*QO`mZ(5ZSy?L`8xBy=2(vyZ@u|?^GnV*m_IYGXI?ByI(z2~ zvC^C8an&dpBOUj@YEiQMAFnQs`%w*XywBD2yq4#+J+I^WJD%4S$9kwIj{Vj5yn*Kp zJ#XZBW6zsdULx`l!^UqKC3~c|w2BDNY-N1EY-aJzE`P{Jb8)P>7UFnkXlcI1wZ}U~ zD{-vB*5ZwvZ?*PVJGdU(SbUr7f71DO^Ym7pDo7UzS|t%4GP%S z&fwt~!d}6W?fU@%%@8zxBUvWxS8TKQ_mD#q|dN z#Js&Z-v2t8A8`8{WOWgadjsAf;Rh}L)XKO9JDVSJ?VFi*F+U>S)%=)qyyJBxTWn8m8Eq=+xyEy;C zJgJp&f9z%PFI~K|9S{7nIo_?3IKN_!bI0-aw)j=ozK%Gq)zZ$dSseGeEarWz{dLzK z@5g7c(j*6(|s4-m&ac%bV@`%z{5KcJH84#4h4XtB z$F+s)ZMennyY|TW2=NT&Bh4SUIL>L5cwY0-=D)i*)-?PN^8*&c`!f8I`5h}`{f{w! z?Aqh`GuHfRgj@e{<}aONJ&!m4*Le(!zb`)6e1iEa7q4pVCyGzCc!amGSU&Sf7Ju#9 z?`3}!N61PJMc8X*EcX__s^F88tK14X?2G{Riizj!-hw=7#zTfkYqZEj2 zA8zeG5y$iMfH>j@JwN36Ve#D7{)l-BcRaYC95qkryoC8N^Hk1pe>*OY>+OVjY8S`* z>`C)9&dZs9YMxf&r_9rdpEghL9PbZjEa@4YV?CVp{G8<{B98U?nK<(Cxj3G2=f$&` zUl2$9qUV=9|3V!5`_epm-!lVJOdEVZGPYR1M@s?{601wJg+&f6&x=-pZTv=MtpXQ z55?1){~?a`^2qbYo zoEI|3&w}ti{@mh)U3|3jBIdaF;d(~AsCj8CZ znwNC#o0$J=UdlP*uf(r9FKux=3or)aWz6e{mo@KXj`>EsocT!c^5zT7F~)xuuV{`B zzQ4Q{M?NAPYXSF%AZoFol53CgqlgznSRC^c618Mx`)KCTJdZAp=S7UDWh2|eL&YbV z#}r3AOdQ7;E{=FCam;6Iahz`)aa@0KJ&z}j^%Y+n?GuP2o=_a?FOhgP^Tguy%#)Z` zcKO73NyVF*Cllv8xOo-V9`}P3;#JI3My(iBb#XlZQi)^zr8ckT;+f3Th%YuzYhK;O zv8K|Q*Km&eb9!;C`3$!Ih&ZmNjN-_DCh=W%&&Vu}couQYUsiF%vx(#S%`QIGJcl^) zm(%lH;+UV@;%J}8^Sqwt6G#92;^<#M9Pe`l#St&$d0}z1FCvchQdAu8m&L?)m=`y% z>E;9Dmk>W;UQ+z9c`5T+uKjWI(&9gvmocyH;#f~*#gYGV;+UWE;)queFJxX(yq|d` zaU5@D&#Q z@zv%H#XmD|WL`(+ud(<|i#HM9W8T#K9oHV-OdRvu+`O)f<9cr)j`?XRj`?dPj(BTv z+#lPBw}Uv^cN9mwlQ{C#S-hHg7jfJlyPDUNe03AY{js|^?vFjp z>$~OKL#Al0RzUGMI`{i75#OH}){^pD0dR!om?_&$i zTe$N>|3%_S%omHJ{Sxz*u07u0mWt#1&oc8?E{=RG7svUm5T9heQXKJB;>gEpam3e% z^}XueTAyZI*b){>vi;#n=eMLduBR`WKlJ$#!u-ez{+h_fIxc*o_`^C{d z!twnnv27n){9S4PiFjv=!+Tmht(8kT?`4kfHpuS*i}!Z@@qT$w9N(wleJqaLB7Vrc zuWOIfzo4@Dc@FU_l=A$;h5%Fy1$HcK-kBeiypAbj1XzaelvuvRq5x*~<%>02kuE*cSaesd(j`$zqn9oPzDa;>>WBe!L=>Jq4@ju1!{P{~9@xR3p z|3@6>^GqDq>vM6;=L_-m<}byMnEz`&Oy={IIKB`4C%)MHwfS(@9`EBp$p8GV^AQ%G zWM$k_5g%#3%ZgZ!Q9^3j-)X&h9w1*)#c{kLo=5XMx;Vy*A&&7vZGREtV}4?aW4(ll zV?Bk7BOXf}*Hdh9>@SWu@*mgpc;Yyp_~N*p5{Tn^N@zaX$NG(3oJdHTwX~mJxbmEAo7sviHh~s@W zqd4N3JkKm1)8bjg(LSp<;@QNJ|Lo#;zUL6f`+83EagzUB;)v%K$NPL9^YN}dJg+$3 z@AHLJwZAicv%c~C%`cAk^8%h1^t_Nbp3jBFk>4WXEzFCWPjvgk`4$r|Z(iJdl8es} z53_Pz+e%pc0~fDjUQ#@kc`46Ji{pKujOS&=@xES89OIQ2$M=g0mcNMoV?9(9$NH%x zp3%};Ssd{y;>b@`am1^M3J=2+z)DtqkSFE-|@Vz=k>&~Uh9iv zyawWkHx$SGHWFW8-dKE|c@y)=Zay(yQ*rz}rJ49D^XBGLT>FjYEyRzRw=|#X;x)`$ zi6g(Q#gYFu;)u5uFKgaTe7<>maU5?4&pV1EADzU}zOy*uUBnUZDvo$Jam2feV}5&x zBmS;9;yuL??HIG#77#4-P)#j!rdh$B8$JiGZg@!sa+ z#c}@cdp z#iyIkF`wnyFEpPkzR`T1`D_=*^K8C2^0`19`CcfF_#*K%=8MHEm@g5>`7iZ+nK<&j zTpaCJh$CMs#Svd6j{L0_Z)(0qyp{Qf=5r)}YsEWSe4Tg)^Y!L)U3)wqH;A`3-)KJ1 z#j##Di6cLo#gV@);)rh*$N6s)FK@nG9Ot{k^N+;Qf2TOw?-ED;c8eold&H}m?-j?- zC-#}omwfFPZ(#9{#qs?A#C(Bk-`@Oycr){Z<_ldM@6(6Gk&naTPwakhL>%#>;>hPQ zam0^{DPG96zu5TpaHw=gk+p z_9e_Oh!-@!Xud@9bx9oO`-M32@ufK8m&I|uSHzKztKx`X^ZdFv@^M2P`S?m4`S@BK z=lhNMQpv}+;`sT;cjEYdchh{CYhT3tmN@e9z4>y<#}DE--`nEI$B*KO|0Is{y(5l% z{49?6FP{G@j(q$kj(pq|&tra19Pf+w%~wc19*AQ-{4S33eQ3VYwMYC9@dDaYec>YWr`FJjle7q1xK3<9=AOD)KmVCSt$NByz zj(of}UnBVlqW#a2k0|CJN@{vXy`ABQNLGqDK9QjBuj(lV=-zfRWD2{w>$Wm$SjWY z%_5F`WEDp|n>fxlyEyWZLmcs(p63!rK5~mAA9=))kG$f@M?Uk-l8^l2$VUP3tmXyH zw@5w;i6b9{&9_QEiiqQUi;5#3#l#UWE}qc5ggEk1QXKgx<#}mw^e-che3TW({FW2P z^P#-?Hpxc?aXeotisSiI$$YzOkN%a#F@6>E9g>f#;yB-G;>bsJal~tg<9uq0BOkTI zk&oJ**AYkmcf^s8y5czAdg3^r`sN==J{pK49}UHkk4EM@B_EB&F@6*CU6PNc(dtDy zeqPf|96tkU?s*H(TYBEg^VXiX@w~0)?L2Sqc?Zusdfv(N&YpMiysP*XJ74&2%MafD z3p?Lq-p$JR{?N_hdtLrU+50SfpKG7Q#rK=zXCdg1_{Zk$tc>qd@K4M~TKSpt1Ln)E z+|c|j_;u7hr}`8hsFOeKO(-*{HXb9 zneSub*DQWq{73T>=4V{{JLV_F8`*q+YJS$mH(LCZIF9$UIOg|^IOhMXIO6BTF@K+l z^XC!b82`NI7sQc|i{jPHFNx#lA77ZClYD$Bj{RL0uVjA3{4>`c{jZ8wH@{~7xr<}} z*FC@C`B&n2Klxf5{lD@2ThG4}&u8s#iX)%5#F6js#S#BO9QnL0zSaCkam0TT$Mtqc z9P{|A=F}XX5DpTpayhh@<~YarFOJ9Q|L3qyK;6=>J+A z=O0A>-+IOQM-j*QM-|8ZLOhQqj{Qd$$Npo8WB;MzSWhv<5f2kb|8Q}{V~OMXh%NrD zc^vV$c7KX%eqOHcc;b019$!4%Jc0QI*ZyA{FQIr2izhO_=;HYIX^F*gJtYyx^_El| z@nqsS|K#H3%~OaYo>Cn7PbH3grxr)P(ugBpX~i*KI&s9)i=%%Aal|ug5t<`A#voZusHHnL>%K4^}Luk+7}nccqPOUFDZ`kN_k#d9P?8~ ze4=?-@xJEe%rDFQlouak@e1PO%`2K;aqVZCR}$Z5UfKMri{txU6>;RhsyODSnmFRs z#c_T$#4-Oh#SyP1j`^uAj`^u0j(ol&j(pY?$NjIKIPQP-#c}^@AddYt6vy#2636(B z#j*b;;)pjD$9y#tZ))CL9Phs^%&*COwG{7e@mAva{@&XBx@(X5ZX^D#d0X=vE{?yy zXeW;OXfKZW>L8AIM{(r4lX!je&f>^V7jfjTt2p|16Gy(fiz8n>#4+Bxp7#_-`(EN0 zueUhjeZ-OfzT&w5^b^PTK1PU-Fdr$7_$YDYf3!HpA0v)@jTJ|}#)+fh@<~R zarB=gj{YBrqyJ=a^q(S*^O-7+_%w0!pDvF03~^lVGsSVe&l1P=K3g2eJ4YP-=Zd5M zJaP1&FOL2T#IfEMiqAG*B)-;svH7>M-j;|Tw)j% z)2$RoK39ojeXSP9{Hzg2{6lfX*NWr!(X124`0K@yj}7AJzfm0Xw@DoHw^>e({v%AB&^? zC*q0B4~S!b2gPyxhs1IGhs8185zmi`BY(%lk-y{O$lnQZ?Ej=V_W!9k_J2wo`#&v? z{%6F||ExIrpA$#_&%}}c&&4s`d2!_bf;jqL6i5Cqi6j4Ch@<_N;>iDHaqRz!IQD;4 z9Q(f}j`6OGWB)hAvH!2c(f(_3?Ef2a#J?5C{Cy{m`MW8O`MV{K{@;tE{}1Bme_I^= ze-uampTyDsjyU@NERO!ah@=0n;^_aIIQrieNB?``=zm`v{U3;<|L@}H|4;KC9d)NM=`G4X&to>{AA6y*!4`TdZkK%b$ar}HLL>&F2c^=*K7~+?#eW*C{ z5mOw`moRbUH(VU?SmKDs79V6DM;znF702}&PaOB3_~N+#BoN1ZClp8jMB?b5SRDP6 zh@*c}ar93nj{eET(LaSa`ll2}|5W1WpIRLK(}<&gT5;qfojB$%z4#>a4B~6dGn(I) z^_NL}lf^TOzh|Ds{72V*hIv-;Rp!~uf0Ff=-SZrt=M=~K%O#HE&+U00&-02`v-bJK zk&pc1SYHLivAzn5BVI@x@xtOb-y-4|zoXSl=DQ5$`CDcqeiE zeMx6=jNircuHrcUZsOIv=!V`->z0?}_912Y5cv^FiYH`u;<$uAgz@=s#W@{ofZy{|VygKT#aVGf5oz`#`*_`DF3F=2Oh?$^1_h z?{D#G;w{amo8NcsyO_@q?`=NQ{DI8>EYD|qK1Uq$KUW;bKhN{|o-YtDW$hP=BOi;z zF~5t&F~3X15nn2f_%iVZ=F7z~{t9u--%4@J-zss;-)eEp-x_g@_n|n>f30{^^L3uD zH~(GcZ-aPaYrj#vuK6bOhps)&XR~+<^DX9o$oy^fe4FRn#W8<7#Bux|dA`&0UE=un zYP-dek3Hg;pS|LkpMBzp?-xh>V{x4CC*m0YfH>ywpg895kT~Y=usG)Lh&aYODvt9% zCXV?#?)eGxM>2mW#W5eBievsxnLn2KJ1vg;(;4$8GJj`1Kj-;p;+VhB#c}-SJ-^`j zMRCmEC2{2A3vtZPm*SY8%i@S%5l8&0IL_~yIL5y&j`_PGj`{ma9P{_JIOgvgarFOI z9R0r&NB^7R=zmKb$Md~7^7n&ySM%HAgUo+4e=76;llU-;-w{XupUwYt?Yo%&B0j+U zSM$GQ{(tlQuIKl}G5`0)ar_TF|K0P4;<*3*A&&WcB#!xfEROgSam1gBph|PMT;jA-({ZI{2$kTop};*{JcJ?`7^m5l8Iw|B^Sr}q!33ur8wfL z#PRP{Q;TE$rSUwiIL<$vctP{@;@QnJm_L{E&nTYN;+e$rm}fSB;o8Hqh!-=@YW~v2 zbDL)q$N6O!$NA+DM?9xE;pbGn#Xo=cs=tt&X=3lH;?BW-}f4r$9I0kc>?qFR$k~lu{r*3uCHwkt$h;LK8bmw z&~}kt)Ok{i<6fJ|w#K2g?RUJs$%jov(8Tkm;`saiX5zRWn}>Fa>_5l6g?VxrucbKl z*-9MOV{38jzm4Z@J#QzT$lA9T&uHF39M^Y8aa^yR%u~4IL;gF5c8m0?=3T^bJYB_c z{M|h7E{^s+#IgT(#j*dM<|$?Wy+Uh6I`Z4w28oDcygm}g_1f3-exCOi$C`dGv}fda z70m~jr*iv;544@6miZcF@d(HM275k4{FTMwX{AKs=uL zWY4FF7q<9R@tWq-#Ie8W;@IB|al~heXEUEAj{DPWaXe4vh$Fvq#j*b8iDUiEH&5^8 z1M7c*_)W`CgyUTazwct9#WT3}ldW!1=n(rI%Wvj0rTJoU{C{wkm}heFJ{E^(HqUQm z91lE;c`+;FdR=Os)wS>9JiB=TD;IK}!yMneaDL0IeNNXN|DJETcxm$$;&{JYX`aiq z$39nyZ*`u>;<>Fn)OlWW9B)V4R@)>MaQ!h~YdrtZ#*2t!{?>ZF&TGHk^9`PF^n8=& zn?2v+`BvG#g@SG3QO&n|?RQALv&BC$FX+ya!p<>2yTp+ncu|XEE^+e^AIF9$AIIf>V<`rFkTtA1!(f^3$HzIDu;HWs>SB{Az ze%$jDo}cvmQ_oL%e%hYT5&Q3M_5=v?<@04E`PPGJ-o6x?yVVY``WyUi{pCwMjY4ow|2e}aVrMjNxY=_ zO)q}S^Y5j7K5PGj=eND~KYIR?=XX5++4EmK|5f&f{Qf46_nEumh~E>(db}@=_4vTN zs;tM~#phc5q4;?7KkWS@qP-nj@W}JWo<9-Cd_491PjMXIU*b5vzs;-3@%aT`m$BFa7q4&quUdJWZF#MILpL6-pM0L@7svCXfaN=)J@Q>J=B!9ZypTAa zKZVU3x$$xSMZ_yRZ)|aVe?b4D7H=Z$i-{MrcyaOg<|Sgzi)@eeRMNbu>kls#bCLZw z4BlM-n2*xp&Bd`cYTH)E;w@Zz>@UI*&uLrPnC>Sr$HS;dcTbWlk@8%ru-!;Us-fD{D{u|-=Sp&|emc_ff{y4|l;+XF`;^^~^ zIM#1n@vP?c%zL=;upa7*4>50G{;rGTdTS_-Icg-1_1svzz4PAIA8P~i*~H>~+;{_> z_ccch=Z|?=Ft@-9sEXdpG8)$njQ~_q6*>#Q3=1^zyv7=Y2fyE92q%>=$!w1H_T9f#PUCNF3u07DxLb;uvqJIQkFse7NT$#L<7GIQBP69QzwBj`t}&D z{#*6%dDgz0#U{J>eDjx9PGH+Yi!X5F*`*jP636i@7RUNpB98qp701ul;0tX$91FhR zFEd}{#>e|Ke6cxlSID;I=1W|>wDYCrc=l(vZH2{`xj5GAO7V8)tHiO!R+}$(?XiB> zh~xhHp*W6ltvK?%P8{*|o^KFGJ~oOYUz@}+-ez$;54L!|RUG}diKG2?apYu&IIh8u zVunVZFXm&XcrKg&2*=#yhp{c{*IZibMXw8@RQ=$->2d@zEk3epB6{_j5y+F z#SuRzj`(Ndh<`4Q_<3=}FNh<4Q5^A0;)s7Cj`)}2h+h^*{E9f@SH%&(CXV=Zal~(k zBmR{*;$Mp+{*5@|--;vtojBq*#SybaP&p(Odet1V5@n6JKn*VCP z-mMqhU+#%xjo%l?`g|ac_5M&CIL7;19PR%R$MyV79Ow63 z9PR%V$Mx}_IR4J&wK$%iLD>I}7eA8-5y$-^jyUokPaOMCD30e{B16RaqkZDA)RB(- zCy{sz^Q2+fBjY&#WD-aJtBxT>Dk#Wz9cwKEwG=bK4c) zcM#uYj=3FXTRHPRu6<|E@qG~Sy%vvVWvrj_=KEax3U<5|%s+PC)Z!J*4>-?eUdjBR z^SkDi%?~@TDvl>`1>34v{D_OUHm@p<_v32jM_nB2wMJNhNXPHks}+_d((ycfC(M4I zo@Uix3NVNF+Q$`w&IwhcH)S)7e~BH{@qE7Li#%WI`3lchd%iZze&3>7 z54c~i6UXyuqt||m=i5Es>G>Yd_j`W8^TVDW^Zcaer#(OC`FYPTd4AdRYo34Q`L~|m z^8B{vcRarr)+sXIxaU0x>lx{l%pZ#5{_$8G>;H*3?!QmP5&u)XsQF*wxSswA8xpy{ zOyXr4#+Jcc-a zei`a{n0R)JhkG8&^Vs4!tbIIj9DmC24Hea ze#~8;9nCYDA9vo}JhS-;=V+hB{G{_y=Gnui*?(gYPm?$QelBNt-$=*%L>_TGKk|mp zij3oZBA@s`@r+i+@gjc8#&6&}zxipmKdk2nM_X(KEPlqtF~5byk>4WW%Oc}wUsN3J zi+Nt$^Ah5CKP@Sa@BgJdFD;IrA(s)y@st%uyqq|Wr@T1cDJpngQ5@q{636qmvgcLA zaeY@6ZzEpB%D8`2v-nw;PaI!$ag1L>9Q&^+-bEZgdqRF{Tl}0G58o&1isSxL&-41? z_`cB~d{t!sc;*c~Z!C`YktX8t&6|ni{inHj2J@EUh_@0)yj}Rl$o=;=?;M^Y(y<=8 zg=dd+#XO=j=AI%m=e2zHsJy#t0o+plc&lg9& z7l@<(LUHt8B#!=z#nFF>IP$$z9DnD$OuV-Fa`Q`)?-k;RuN1FozRLUy*B(D#U+wuC z^DiaeABrQNYsHc8b>fJx7e_ufh$G({#Sz~mj(lwvN4~a*BVSv^k*{sy=)YYY{db6? z|3~8Jzf&Cf-X)HF?-oZs_n2RneD4)Ue4jY-z2E$b#}>z7L5b zepnp&JR**K9~DRZm^jY=xH#_5C&Y0-I4O?%!KdQL_bGAY`?NUneMTJnJ1dTSpA*OZ z`!n$x=AWBilYE~SuVe8G;$_V*nqQZEUlOlk@h{A8{6E~id3YSf)jrzOYK=zHjAk?% zt(Ii%-ep^sZF%1}@V*<{7+D_MvSmruVk3-j_l&&aC6EM2AP^D)Nk~Y(Ku8D#14)2v zA7p_nK!E%RSqLFt_MQ8_r@E&{8}Qvf?sMV^3Rc*f?hxqrB;)Lh- zlj4N;50c`1|HGvCXvCjOic>y(J}FLk|7bw`#{=R&Ns1FbKTV2rK3+(Qb3R^7igP|* zN{X}m&ywOS|8i2CWu^^YeOA+{F7| zCdK23{|fP+*!hnl{_CXprxE`R;y<w z_epV%_kRY&|Bw_XJpY&!XMKN4iW8oHPKpzre@TjyKK_~%Cw=@aDNg$Mds3Y3{Ua&P z^8ZYVv;4o3;w=B~q&Um}Cn?VPdpjw<4{?HvYcY~?YGS1!C9>SDeA2U zXS$u*`sYthCvB^?bjc5ofJANmYk2QDHGu=`!PsRKZVD{!lA^}QQ-8V*0hMw&QWQ)K zoM{8zOMkp}9`4jVS{a_YcsixXw^$5GNtF~}#-KdJCqu08sbXvQYSWOCCOLglHeJeQ zXv~=@IsK9|AUS#34KK7}51)(q(B22wdgQ6&>@NHKDpCwBh|#5L3z6c*odIlxIej?a z4E)gkjkg(+KU4b>Fd-l*NR#?+M2ZJD&vJC+$*__LtQzF$&bz`fU24Y8SxRli6I={A zJ^1zy!++5SKEIum!aN?_;?1_0o+9}@xL1)WESsW{55aPSzUh+gq!4d)EevR+;Jcp8 zQ@6mQ5la6oF61KM>#j9;ViU(h@WDO}Y zmPY|$5B$!U^YfCPT$XQD*)$t6I#P7W4=)SUW@z6=U8&m7@$^a!X%bGy**#(f-}<%P zs5yX@6A>Ge?*hb-CaoWn!I1VH_&kfZhTWpV@EcIp!1q&GiYX~}_-PptpE^#eFx^8& ziLdH#Tu(?V9_07nt|+D_hdDa*LEtb8AwV9bVEsY5AvGkwRouxLdjnc=dUzx2wP*kR zsKLppa7m4e7?Ps>2|aP}Z6SlWF_h2w(ueQkspF0o=Ijv&a73vBXD5%UQ{{h1AeNkx zE^zn}YD|IeCws_#rrMBHrLIDqy4EiJB$O1apj(qZjFQ&BfOG?=XZTi?;#>nK@zx_L zy7qI-MT$TVaKPJC@lN-`Cz$k0c&f6BroeBJN5>b@nLZ1B@Zh#GrjVPZ;L8eZ@c`bX zYCG`+t|BE3HxiK#bl?eXk@WCaGHRAh!TrrF#hFc&nZ=Gt(iMhZhPNL0m$8+nQC4wL zLryPY?}ijeNYWq0H(r(TK9}^AL2J)QO7fHEbYRUyS#SfX=P}8uo{J=`$|k4(5oH`a z;jAhA@h0K9qW$D_MVkue74Bh`#~5|^#&Se&pdRQw(I1C)6mRL2aZLsUbU6vEeC`Yh zrwR}BYL_EVnw$xDT2W;c=j0lS9kV`NQ!}P4G=37-YPD-5V>`nDPbOkA>?%_!Z!>%=Wa|}iqrt@ z9>N}*+o=45d-Con9^9(WcKLj7qdNx(cyKo!^DD@ZUfx^Tckj>tH|ybQ=tvIN5*V^R zLI%SeVU0sPMSB2G1OBL-_lJNLUfdr=3}@IU;dJdLf$INXq4fX$aV?g4{JG59XmBu( z#;4+M9$9%YV?v=^`*e+88G{5Nr5M(6#}4QEF-a%iQ{0bdMOd54&#+VHw?R!hPGYmv zY@{1fKlV0~U&+-{nazjQda6>?bG^_nc}t3T@jFuDABCd3q%D<`Yi^3R8~A3}WBH7X zr5#Tt)u-62>Otgz{sT`BZjp4~dZmXPdn#_qaz+9Cm7J7(=*7=cPap-WCq`$;6T4Gs zD;H%`Wc@WHPbzL*BrULpH0f2kHVSz%Y{(~%_f4r&@l2Jjo>?+da#UyRN0V~aNIw+> z+}b=iDZw7r;YEt3@~HVDpV#ft&6Z;7Njmk&TE;J(x#3%p-`OD&!*!7@VSSSNDOvG7 z|0wY~Pt_BqDEVAHo&Kww7o}!P`oo$Hk=Xg21Gb`MHdW8P(#m6~%~^#R_J|CSBJwb_ z&yq*wXWu+HKgawE$JCy*L27;hZKc@zBbELy8Ou-b7T)vH6ICh|VGr)XW<5X&yjAIJ z3z&nqy4?q+8}{1@gz<+wn0fR8JRko(_`V|ZUkyA-(@T!nSm${A*D9_>y%bz3%D$Yfc0 zon0GKaE?vNa-<%qLCFkGSZNPFZR8-_(s((jad20smfDmjwkFdl7_^o_9c z*brl#s{jAbuB3CN-SsK+Qc|GWQ&0AUJ^Lu0=qUaK^hkLgBb4a}<@3*@J&ac}h1gN6 zl*^%;z+?i{8ia04nfD0okd7n=>hHk@y}9Z(T1woa~pQ; zYH4d~Z0Ve&wYTBX-Q3zWrB2(8e^VqftzO%We^a&H)3n{wwcQOkUbUyOs}Wy)ZqmBi zx*A&+_H;!%*GC)oXuA`k&S+Cx>z>YyZ4377(OMf@+w5RdOIvGnkJb@wk2ZE8u(!FR zvuj1`k;azhJz8gbw5fS-b9B$r=4i_vt*vW+v}3)UQzbd&R4m$R=j?3j?r4gtL{!yn z2lqrfyP8`YyPDftlWJ7K&aTFeE)_f&?NNcfs#!F>yL<26XvdP)Jz7&sw6SAVv}=Fc z9&LYPryV+^652YN_o0E7#m${fjUC9mzqw`4>b5;mt(A{MjhzQKc0{9E7ayJ7yH`a! zI~(^!wWjXQuC_yqn;Z85FkQ_}PI@ak9Npu@qE~lCTRYKtC!w>eqr0igi5;>l+uPQ0 zsIjZ7ad!)v?b*$r&gRyA_}K&4weE?wHeq~-?&YJar#-s5@laHA`Yw^Z-7PH=0LYp; zn%leDIyx8j*eOmW5^ZH!%zt!aGXj7JfV8r?6=UMeYH9=<(FmHuBuXgS+I>g@O)VYr z+r{@s8#`CGb!|ciJ35=%I-**0=V}ajQ+s=~V^L!#D?bul-n?)BhVG7zwtZ+)Q&_c` zGpqp^7^Mm)Af=*7^R5ywP5Zl4@Q4&90&i%(hMl}Rx<^6|JQm8-OHym}sQePG7j$$q z_DHN#%4yN7fvuRWjg9*>K$$;X_)qw(YHV*u-!z4mB##Z!S(IreM()#^I*9(OqemBZ zG`2SFw+Gg_p}Dmwy0EEbNqZX-0o?ssOJir(20ZpFKvu1#`A{d)u`3j<&8g8;=$> zwrdAEZ9>Nc$V6;xBjPi52>-i)u^{_H2u1n8f7H+pOv0n3t?ghpegN*JMBLTghjvFh z6qM~Su$W1J3{aNjys#VOj^J+lH))t_Iwa4*=5~co+M({2uIBcZW@O*r*t(|$zk-U3 z+77ihb|3~Wln6IDiAMogyldRk*v?;p1JJJnD9~(oZb4HM7(p8{IRPT*qQ;h{?v_T- zu?FVu1PQst2@1!wIK-~8AxxVLy;E^sJ1q0n$yx1a+@QER$8Ixt#oO)V_U_#+%}qcw z#dVsaoh}PvL{^Jc&8^*7FSJAUZ%5-%Qb?!5Bn6aC5Ja?fO>4AmFG``)3p)0pgkpFk zfli@;PKCy-7^v8Z$pSA{@CFJcIGmfZr>%=GK-coaWl2L?JAV?eVBH;EHV`&MyO^Cn zSTOeCrvv}n_U`S(4*|V0x)*`{&3Lx8fD?jzkfjr|twmd+hoY@rtd2iTU}O9hNG@vY zMsN?7k1iDy!XgPv>slvx-=38~M!`r7uzh9pNVH`o_y=ed56KVW*%RHfqP4xdOKX;= zB&_M~VoIC(ah77VOC;OK-&Q`l_-F?Iy_)NBOJk4X;ao_B+i8vDdF~YUXuI3?^so*M z47)wLv29}qUN;LJHzL>qSS)GnLI~r;vm?3>T}7a&vAwaWxvNL$E!u&A{kJ(a`#U#$ zv|-g9zpcLa!&8e6{5G%P?JGYWT6OBLZ7Z7M^;i9E_quscru`uMeH*mL)_h#Q^BZIT zy|Mb&Me}bP`}Z~Zp^m?m-uhPu7=4SVY+ z*X^D$W8&C~-d^v99xUyLQat8|^o=u9&?B#E&gb;U+tj(gv7tgQ`eckNp8HZPvS@3xqq!;FezjsvrX3<0 zhMe$z@>Hygc>@z_H$sH!%mvgu)&Y;z>#=U}SReCP_j#;K0e4{?0yNfdBRj$${NClh zd;j~6Z}~rQC94ATI4Rqhj?o!7*9-_TJ#b|XeDcBa8cLe-Y1r%zvgjTT*{YiTUOyNa<8Vb~!&jzwn;h%5* z7zF|63|vboZ$_EFkg6t{Z`oD|L2FYcbQi&+>ujsjX|0=WbtBMsIKfjlQN&iasgL%1%R znm%FxawlVt-xI$>=9!b6vnavXl=Lyg49B02cyr@ZE1$~z>ytlv!n0u7HLdE3Q&O(Hh-Dz(=Ic767-y_k!MMo$2r%R(`X-lwG#eS=2NYN)cZ zt&gA+fL^9H&gdD3kEn(Gnpf969`ktv(9iOs9mcgRQk#T??qsSY3YLYgc$-%PFS4!2 z0$H4bENw2k8Op%BfDX+V7^N4VsOm{)npgAhL)Yh&;w=bP=G^d@j~c#WeCDkuizA~_ zrObLQkfW7xG}8=UHbIv~z`)etLnXL%Ap9;5;892wgW5e!TawW;7OY}k%p1su(cP&s zlU2ed;bU!SS~2@NRv}7ZtXL?wELJ7IBV&p;jEvRW@!9fQ8e1F~3nDCvtwcOzV8|J) zW{S}h!Bt7Ve4>Hf`E}l&xm-YEO~~p3tDKXQ&0I3O_{N~D2R;QmOkI{j6ac3Tz^RU1 z16T`~<((9g;>;jjIgR?K=+GE0^7+C^9jNEDz@shp5$XHL*xmA59lK9{Yhn+|@0i%5 z_V1JOJ2Lita2{~8*o%R5MX@jr>EMDrGtl1n*e}8M$9aK|Ax=3^J4?fQn2D>wdh+2- zhG|@C^yHAt1rlDZ5|jg`P!`wGfD{7IGPUIfr~nk>#iew<4A3=73bN-Bi5GbfhlmAi zb3(ir6h64kAg(9tDbT7CZRP>xS;&if>S}m#tEP_)qfCI8a_>knapRXiuhD(0PV*Z(7w89WkjzU1NvY$EsJUF z9v08Cc(2nvsZu}!2w@%c`O=5&9yn4>{HDN;FhO&BATqFf055pX5Zwcsyw~ofq6!=z z&tWHt7|y);67!a#ReIl{lh9y~ivKKN#=r#&;%}e|VRpb5@HukxGESE8Im~)0m>4RP zG?yPj+{zd-t%k@2MgczO1quOR1;+6JmRD4s(o4$%qs?{Q-bk9$n^X#a8HzhQX}U_o>Q!d<#{cfU;SuX#-)=BW3_$u` zNbCZU!I_BMWF(hXFp_jNp3Fl9WYYV<(tsCb$G}$;StH~oGV07WC)f0X&UO%RdEZG8 z4d}6m>?R$oT`dS+&VzKkkZdVH&h1lgGmRbtGlIzwI?VF=aM2#y%IA86%-PH=Ri$Xi z%mp2f=|<1`eBepn{loBaTq+shG=`EM!sRCs1qw1yhwwE#d<^+CytoE-k+QxY4pU_b zx=cQvJ;Wn`e`N0~R ztt3>`WY1Y4sk)59Jyr!S5tS$E(e;VMQ!G#E_|PTzWTlRau>e~SWClz*Ljs$pNIpJ>Y2i@HagIE+PM3z_H?Z%-~hqKb(U)WI?j zT=X5zQ7id!9hY{2-KA@*m|3s|VokryfWD_ohp7qfX#pkT_%T2&zzYehzxcH68>*YHh$v-##t2Z3i@4NYH+p7z{+6Ur9 zPo~q6RLh<(Kh-PbXTo~f00y@M0^`Y7Gbr>yQwU-b~z0)OInF} zgCv%l9|q=w%@Vt(nRf}rRhyrc-;w5*<+sRu-2VNR{7yB0VE?`-zZ0+loQU$(=9_3x z^c*js6@%BB0C=`Ml;PMgd8WQ_4?zkg^r)01;;)bn} zF;D*W`Q?|ouekO=+JXE2IVSqG3nPoUA*)(D4T=b3R29PWw>kT6kR#}=W6 znU?KFrlk~tB@>Wc#PD>r{{mvN)|&Py0n|Ey;W5`N0>T=yAsuV>E#eE{AOsEbeH-}Z z(jl^}9P>8pwJHoyZiuTDE=n;!gF>ir#t7Jk%`XD9u9#g!=1^|W z7g=EbH%cOzb(WbwQV~>%&D<-%vysFzDOKhJ-Pol{&Hr&rm74!>BV(-;bRPxQ!h~LH z1<^;WtZAetZY9xhx&f$wlxmFQ`OxNIPoJSRgMfV7bZx%ZHHEI~5b>Tx4w z)(JOTgLR`CDYNBSx4Lh#EfN;0W}mVxivJFdaIwj@zT%`f$%J>d^>n{vyp!E|nY^PG zMshn3+0;me%R%i`)~~UNz>F8+Yd@L?*9^e#09-j$8+8nO1Au!%7LZa>a*ly%H524ha{}Hiu zSjp{3O>A30)Q|LH8yRavm#~^efR`AuYBU3D%UpY5P31a8B_)ulnw;%bCdhFq#Tb^|68Y#??=fD@k+y9vaCRTIJ7ifo1e*l5O#3Z`eTSe6FpU{HV#)5ELB@F%!d ze0|4k6m?N{bPaP|>P=(|9+3BwTLX@E6&BgUephRHvldBob-k^WAEL`Q7e=NXd8uh? z!)+fLz5k^ZOZ-;wlb2$J>{?MBx{Tet%qJ7pO-I5!!*`j}*U-EY_BC~}=vc2^E=%m( zwIKSd44@}QG`d97=3jw?45J?NMiG7&WC>~(_1+q&dmy&Jb-{NzVVtv1;SR&~Z76gF zd>Koz*d9Z8GB?6A*&8gF0dPHp(!EO0Inp?8;AU+!nQ{yo?vS<<(rLyvBFY%^MifSU z=56@hq!hG4^G@~#FF)z7dA**SwO|5du>K4Ity@+`mgPS)ZA5GFn+>;5>Ms82>0j+C z2^iS1X`#vB_>h8e2!fI%cgG{KxXiL?VI0_T{p1_>C3pXVcLkr3L2a-vXzaxqPt zYD?WZJiZ|u$_q)G={wwj?2C?I7$M4HV~9*r2Gk^yx{fcFql~86EQ<#M`6s&_7 zQ^tOpA3}p^hR>r-rs@MVWMO}VeuElRhEENjVFq$6G9N}Cwt$b3Y0730KG%j`0hc&P z&ayiKj|!-^|5XxWya9}W$YYHKSogms-29ToNvR*SUj$h z3sW{wHA_DrWk%!TeSGWwXen7Vg!i5uQYO=1vKnGZxm5;mNK5l6Db2+8o%0N^C3k$W z_h=rIQ!ywA?h?}5RG<9?JF%|lJvG(Tv(Ev3}%`Jh}qnht6xl~(<}?d3I8 z&tF#Q=)i`pC7Z9yDT_n0{pjZ=(;Lfz$;5gNKr*EME!+G34A)SO%h){z=3XsC2*;jKkP2Xd_y|*&t!%Yfyv*sA10L zE8!sMV+fH(4zz@L}s{Ad_~QNQ!y4bt;fK4&gw#dD8k| zAalG5-)21#2u?uQ3&H!1KxP^Q?_jMR|Cfr7#m228b{cX34|7h{V65kE+zfoP^@ zjL;?+#}V}&CJ=VS6mX2#Jrfu=VxO6#e*bH#`u);O_50QF>h}pd-%}MT{!EGb{ZX0v zeYG+&2^9sj>9OBb7Jw^k5+V&vmPGUB*q=tu1->Gct-oDH2F71;mmY0SU^E z0E&FsTG_TK(M~`ujunaz>;bUJCo&^yK*0d{4NHZvS) z32EVYT^)NoE8ZX@9Uq@L-mx9K4se}C1F?R6bg%6p6tqphciio{<00UENHBht?OQhl z(%rZ1H*vA9E^-Wg@hfX zO$!fyq~E@)U8 z5{B&e_Dr1$TQ+vDfI1nf>{kNbDp|*5F=;_@Udgad zl>x4k%wJ>Iu$kgo3EP!=YQ3;Q0q|D(bmXwKKu|L;7`_r}=4hT9j{&8!P9KD)qgmVx zz)a%T@;qA&Ux8MK6`hK&pl3dLe@O__HOC9aJDmex>g}nO8{83UF~K7U2v`Mg^=X*s{TUJ8Mf8WrzS}oOEsl3{@VzPNnG*bZ#7m z0?UgR5R$X-r7e`iv>D(6)Dh4Wx}AG+kFQbptfnNRit$ASqxz) zdUaPV1a^3Gbu76W?s1)T2krEd^?&TC{G}amHayzaad0jC&6b0(sF`}wPzA8wU0S9h!Eg=@J$c+5x4I1{vWaP$Zf97~mZZM0(u zaNM;za$w;{z7x9mmgg%E{B-+UpI!Cc)wf-m%I1t^6C?I4E^BGq4gcnA#Q!ndPIUQO zsl89T>pWdsgvHU#K8kgs$*1C2CX}$8*4rAuXl! zY~-yCb22nfmh5%Ln&xOFy_^KQ2Xm9%V)hI$H|&DMZUIHIu0agdW{MLFxV#@aTVVMd zqA+mQL%q1DGq{S(G%rEahcG{PCg{Ta24rrifMJ2Bo&>rk9~Jwe=*Af{E(q#{_i&~L z%FG}EiI>RsS(K@Mimeayr>Wo*<1wv5;4pA;GkAzP4T$jR_&^Z|H`5QDIQBl+JCR($ zX)^I;TfBun8q9c2DYSgDbIh8yeKn3_OoI^NC-H&&^w9>XI!!ys>=2xVI}15R^o$g2 zkB*ByTSRj3Rx0#BwEDgI^gXzzOC;6 zb|r_lkXu2iU@EgrOk|nDsH`^fRumQhZr%diaUIhF75FNbR>8r_ww=jW#(YTL!(?YS zpS=)gYhpnp!;~U$>|R8LS1y=V4F@K5H+g$1NHZ0r(lmTt6Ip>=_y`U+FX)%JXk^kL znyKgrRDuPZet<$?m_qvn)C^!HT%E>xL3to=*;XxIjGMJ%Gtdud1`{)=wlbyx%j}9| z+DgeX`VKs}E;^NQPo@OTL~&mMK$g^lH7bD2U!r<)Y6Zw6_BhZcU7SIoZzb&pNL+&S>Ey}9 zBo3gJL3GR4cCeWWwtxwN9Z9im-G>)&B!z@KA2!aA_+RP9La(+~tMIG!2F3~>LMgcw zvi$`T9BCBJQwH`JiKhS}kdi?kWE;*yq`?vPN|^BcL z^+@os7oV@Vvir}`Mce!0TShOt^PAWFgR;Y+#(=1*xj^UdgPB&-s@js4N9GxIOj#q! zE`wghq@4nbjksQUsUt|!RudYK_sm-^rz-JgSj#aFcu9u7)(hu2P=fcozC0CPSxUugFE*lET;z)3Ys`;-(TZ(puxV zh^iiKB9Tkx8sl7qU1N#)FVqILYdV}k(ZOky-lhAXPPl8a`yc^(tRR#WxCvvxu(844 zZ(q-j)u_YDM;!u;b$o{%fR_uXPjM@B)eFWCMg?^#Dkt8!umRuAqC}rTDm0J<6~Gw> zI{1BPRr6eJ%?PxwVI%XLVb^fa0?@(j!~h>F<8A`T2Bn-209$3?14NF63og-ibGC0M z8UaK09j=7s8=$J?&c4Bq`5jM_{aU)U;Fvqt_Dqlf5&1GT}S2PSYx^FJK5jH9xgT)3gQNkiD|tjwv@( zqA={B7h<1qEm%t6%q0w+k1|3Q0JLX)B3K<6Kh{9L6`2EV*oz)~{;Jm#dPEwTBESb? z7N>MRr4Y=M;D&j_28g53ia?5?{#^3Hbv2W2oWdBxA#?+RWg1dY1~%MG{i?RZRazn4 zASC}<=7;=aF;H*>mxCt9%fN?-(U@cgg?Ug7(HzxQPrE8nfy0(tXI9TJPjp%r6 zEIKZ&w!m*)GtaOIxJ`(RYasmmI&<6vvj}RR|RfuU&w6J#0DCrIs zs1TRq0!k9p`2ruS*;fgzplT8>6&Y}QL0NdAXJ|(_s6xs|D?|_JZKlDiK6X3wu;3VZ z3M>)=#Wru|06!hL0{*rk*oZywWCZn3W2eT^G6pQhgM*sD5QNAad~6dTuy#5ApQG(d zMB!e8%{EE;u;DAmCKsZB^v7d}8E$gy<-kfHe_`ww;GF0~Hh2|=fU)JN=mhUEMj_M5 zTlB}gn1M|{fbOAFb~g4W2!W_Y?F*98XU6@3N%*L!N--aYzinMS52_}?oqBp;0^~ke zh0q8*81sl(dD>V=4~BVx{-jgkDa<_h1Sg@t*^8=HP$dA+V&_6LdNtElQc41y1WCl= z%bl)j1%e_(Bg$wmCSw#IaGS=d3fawYzAzajS~tv%s>ELJ;ZgW#E5ufjoPg4}BS_}U zIDE}kj$k)NAhtzFh4u&_l;lzR&!Yu54~|+83nUGW>bcw^g>jz~@CCw!J(LDo^MU>F zETvc`nYSA~mH6H*jMZ+_@&f2EbsL+$-~jIscTugB64Q0whsROFZ=i|-7dJ4y#aKyv zo0_k{rTcKwgbx%HJ)}>t00Wvqa8Sq$;*I7{*_-DZr$zi&E&v~RyE7MHo4lWbY~fXN z3xCbJv#9yG;&0?BuOSxv z`+pqq{pYJw#_jv`ykFeeU9vIfmY%b}tewk6J}?d2O?&`ba`Aa)Jk}7&kQP+t z1CJwCiLOH+%=3jqK>3R^Bdz!UDE!aX`CqDD|A%#lFFm;BbD6JXa-h|se$l2X??X#bpmh?)hE*y&nmUy!7^(|9)mA6~=b(?E(f4#k%7hkR^A_0@BQ4KiohgiM@0UtVtGnLC~v=qZdTMWZYGhN z%nQgh6_jxmdKC~sxHP z5;)@dwCy@2HeF0;v!Q;3fC)9^Q>YP~!u-u-0M(eBy9Y7Y!OY*aP^7rDNOW1unr;4F zJZAFXODC`>a3u0P82tqfMQ%#Tpgd!cg7GJnnt>DyU8TSTm}f0fqgJxMq-;{mV-nSIy4znE4s@qu%ljA+P_bp@C{s5eMLw;#aypc3e?%9@w4K9!s zo=3+j&=i!w{x#678q*|Ch8BhU3G-kZ$2?_ro^{NVs3$#<2fKN@o-)>x0|yDV71Fj* zNrQU8eVB);?kp|Ozl7)9R!SZ$$!S<1kq0uim-vQ^J#d#rMo-oh^QL`tA-xUb#7g0# z1f7dxOOxEOOjU+9dl(sL9tz1^YGQM_MRud~AVL%ZcP`e*nNoxFuwL1_?9OGNbE^%w zXQ%6nogSv6sMy3*zp^rBl>z#7<~MmzjnbMtRxvb@4?v!Vg*>SF<*XsZI!fJG*hTwe zt3Ghb51r7e%-_Kpi6V^Dn14-*z#5o%GYvigiAV)JVkJVBl#LUzkd2A0P&kMal7oU+ zGw*mPoQ#4)J99mn7y0nqnU}}9|LfUjo5G`h_C@cm`@Zz}eqw%61F#ToTcQ9ZeU&c^ zRPKjO_p*5c!fI_Iw(G`G_$BpjcI>wv--yx8n7B=tH?O|O%{YbT)TE4AzRFDpQ0Hz3 zy|K6PYIBGRqsU`Lvhy0MhA|qBh0gXK#c>vT7mZHxE=siQF96Phi`E{53}%`G+fVjw zN|ed;SJs2Zrob|kt%O;?(RQht-~;``zzkCicNRT496MMs8q0{IB6#*A;f10xWlOI$s{xGPE6 zn8Glyh{J4g=cm#*nwva7{)`c2s5Oj}wSr>F6#^hI1}Rhz!5zg011iUM$hM(DyUh+m z1;rhE*jgbC0-DfhrBcHoH3YUacSMz?5iBxiz%l>FwE16-7 z{^IqW2eLmSTa_B+vQwt4oO7Z9y?u8|`|c+E??~xv+E<+Rn6|($pWshg{0{zP-tiEB zf>v)U4{37z@PM8uk@tP_8Px`@wYXkh;W1}k@w2N zv<4%TrLBg;WiQi%*UjJxxW$ag(jA8DkP;#8NX^uyt_3glr&Dy|MhE518%y99tHWmn ztkAD5;1<`T!_O5<(Wi30PlX#ucjY*e99MDLAWI|{ZB<(|j0lX`V%`SkU|i=8lLJJ(lWS(B3?J&)2Sf|Mwvl%1GNu8WTy$nrx%<=j z6X=3GiEk4hanUwp_6ef5^K?F{ zy9A!vkI1aFG^k2oO!qrPCR9~t^k!4)6X+&WpU{vHBQ_$~wK1QxAZh5y0E%3NnFv@l zPN#(q8we4MDMxi$s8s4*Oe&qmw^HT&K}5@o0m9Z?hiFkK0EHMx6)Xo9efAgI9-ENC zkSJn;Z(Ob$u$nRpN{FJ8@?a8$!ylTOw@m8_xJfw_o{H5C!x1${1JqChLqJUXEiQ() z8$p|P8uVUviOYmL%%P+2lI7`PNZHsk5 zv2^SG0qXCHtj~j7s)|7z)eWSRyJzDWyfjbI30&DUuXTGR31x-7AH;(0r^43W*$eUX zBNVn%VBITxKVUs5NIl#7vP%Z}*4HI*sr96rSZIA;5{s-Ky69hEy&{Rrte?9%i>%*C z;t1>aZqAVPA4Ns6ba@$yWx6j%#XipD7_+NwkT8AIy03der*a#G9=ZdaMVhw5SfNXATPCt4YnOL-hY_QtEdPdZgXj$TI6=w{Y?Y9yYT6`xO+d>+P?R17D zG$suSJxNMk8m5hA2yfx$!jMoU z%mM?bZI?}Lv76E-C#a30pF>YjaoSYmhN=^3ZpfudMPo}yV@rGC>8G_?r-aDNpDD_U zhxokU_6kTxwu>1 zU^uMMv2uIlV*84jx7KL0exKFwcJQ7<3u@L*`Y|Nqw9>+~`9>&|BpDwR`^1hmh(TB| zlpK(Kb*c!%RPcF^<9jPb`hp>3;Ue>tEen4@W-{Bn$z@SlP_J>$gXX8)#B%d z;OPYkkoPEAm?2vhZsS`1IA9+pd6a53)M#yoh^v)hmD1tI(QlbHzaveA&F`fNF^N+- zw0;RrG0gNrFtMAMO}dx-!%VOFmNUHttW{)TpaU)tv%OY-|KtgJ1vk@Jtpqi8I5ljVShKn zCr4r`wn0*Y$|Vz88K||(AsT`E79Y%peVkfh@E$+)?34p1@rW#ZFDUblH%}uXYa~26 zRLU($DU?{JVXg@Va0Q6mFsZ{cl$rq;k!*!C3{EtZ1PpvEN7CjQJ#!D!|MDr=AK<4# z7J@=BIzc^8caX(YzC*0C@lJGP@cv3kftT`VZ3#T2(77rcTc)`zX#Nx1St(aYV?Rur zWz;>0XI?r+eB6#=2nF=-BeHkxPxUQ1)ZR7xPIJvYk;y;2^{wW=z4qDeH@@-nyK8S* zRrIBAj^Y**gd|(c8Hp|C41VuN+otRp;e{elXDwBPgc6!}75L-=eU?BBT64Vxz&oOSRM zz5(2;T@GbSSgSh5Et%Se9GsTwPn>NSmdmVtEOPNrS3L5=XMcKY@q(4U9hctNAI?4m z3!0WzV{@6M1PMjYbsy@nU{O#Brvk3I%{4U8?Ln$ zr;(lDwF6C6bR~*{6X6OYzH?xzlqj1Wm=;o4-b9TfHbGD#sZDSrJ{;(X$f$&_v{l`N zb6#)QcD7bm3Bt$vj)!s*Fn>3~Utb@2@ac8>%TH%s<9TTPwydAZSrDw;SoVxKGnTh(f?@#;WB zC(nLZNX1zUfQuk#hD{V|Vo#kPR^)A7cwyl*gJ095?xB&2odoSHXp84`aohX}Ua`bp z_;ubBN5wc8_%y0=!PE_H5B(Q#emkt`hsQdqOMl*)+1)(P_6YKzj5znAw;4(o2}hL> z{mF61VInQ1dAyvog`TUd(U0x@O!GOo#le7GdxTi{a?(kckyKZMNx{>g2PeG2HQ*)T z5A77Cr7HV-lr1;3)klFIxD&xXpCX#jR4+UU6*%aYbyUuV!)G1(NzYauB!MTfnA*^9 zUM@q2h9>ys_-h0-6ReUz&DG$4RyFWBL&vE+r?LvF;2r;m(u|$8xTLhwnu2WL*<_Q6 zL#4bK3we`H>lA0~6gkUU1a}GWKSn0vG@7_kGji1Y6J))mOSRAjxvG2-FBrwyj^T7| z8}E$NK6}gewca=X{OrmjjURvLleeAFzp{!%4keq25<=uep5T;4{ApC@`NFfsC{(%u z1fI7Y9fxv_hClBzxIh%^6I@A=g+{IxUYLD_u+8~9ltjokHM`SjU@6}>n9d=Zlg{Up zJ{OEc=0GQC6&M1KEv=rkzG?u=>`f~}U4>@Mk^F!<19stMtj9d>R5W+c#+o&R%?~-0 zFT01Lj$7e3QdFl=%P1Np_#8aj61k-HbHj9Rwc~s6dr4S>IkMFX!BT^g8f*a z%k&j4i)E>THkpFpwZdRWnwDa)vTh8}T4L)?z%M4?=LnZHZycV%nzspq9cSJ-B!e|S zg`zN>4aH#1`yDWgHew)yH6QH<;mOGime}694#;lZwp8tF%pc3X<_d903n_F7&<`Pa#~qJVsk^T6gQf!isl2t3qZ=VceW-hA1WiR1?F8a z^K!k*vU1Xa1mw7Omc>}m)SGg=spvdhdFP}?D>^;K<`L+HMo zlwh~hYHhLKY{MG}dx1-Amqx7~(uP>xZ%;djF^sW3o|aBcmRwJO<3mO- zugij3p^PkGKoqyM+HXaV?!E;JhMqa`cCZqUSBwO#C!Db?BKwfyP$8tM&;q7O9imo{ zw+j<#gEe`3ftO+HC5IBABpv^rkyG3}QF$gCw9yn^TRsQ@NQ3$TQVVaL1eTbwYXK){ z_F{VasD#*(O6dV&3(-Q59OPk>g&T6!du{YGg$Ffehb$2a727vP%ECiYJgqT{iMKE& zhzg)({u?1N7LBb!8T`^Ep zjje>JS~f^jjcpK7H5j`}YN&`s6(@}y7)(VKijyuSC!HmnG2~}y zGP>^bdp>x@LvK8K)3Pf!t)277*3{@9I5DH^WPPfiCqJWB1pKU1zKAgFLb$Uw^5GY~ zAKd;>MOyFYi%!)%ecSD)-~4uN@@_+{eKLn;%-(IBRC8!vFPuJXUR0c38ToF)>=o&A zhEQybFmJaN8}~}VZ1c0O4kHT&Wv&}RtUd`=Sz&(NR&0E8@Fc&ZV&i$t*?UxMylN{p zUjJVzHva51@ve#u%K(!UBj0;bY*>-^qS(kuOzykU^{&iFQ?PA9(f?$eHIKdTuDf4c zv@rCwa?v)wW zQHk-*06hHI0T>T(oQnJp`-lRHH8^a~H3Rw!?7>8TVL*SeRP-0AA(Pj-(uYhb`-?2U z#7Edyt&gxqOT62fF2C7u^J4xgTzrO`LO_?t;eAo0HD21}OXIa1!_v=Hoss_z zL2TaW>VkvjM`f@<`#Qsr$!pf=%<~N)zb$aog5Ksm(QnEK2Az2MZzGhXt$=PTxd} zDYimc9MFGzg%G2MR5V!XV2{Gqq@-2Dwjav+fzH@QL`Xz~OouDjw|-Vb$BtpGNUu)F z7Rh!D*9Pc@T$=?}#z9s?Wye@X!C^6+4>WE6ZdsyQU?p5yq`~nD21DXY(CQY!e=BbO zV?1nK7XazNRQNRTxr7D{^X?sZmeR0}OHyIrc=X!}rxzig*E$0pBo+>!vK)r8Z5?7= z7x_^zTM%6YMuVt=t;ZBXTTi%&0qegd zakllWOD7@gB}trTz3e9DSihCTi1j19YJD9;*b9tMdjTL`zP^G4hPNe(=)hJhb!c+~ zJR~qepJ5YNmC6V58>z@|KJRl{z_M#eev^C9fk12tP#kd}pk{t7ANOlq0-|9@{9r!( zH!fXHnycW=ox5yfPyx+C;!P8w<-c4Tn~jOx!hBl<6ujA!`FbXB+^D9z%L3R!!;HEN(iaPr@OjJK|v=P0!<73Axr! zXibNONV)&zIqcP{`&FIVKN5}Ouql4R=(-U1a9X;{1ly>+<| z&L7!tD;TPpK;Cnu*ia8z9b`TaSY?Xk#IKcWl(xpz*IL5y6FB<~mJ|Odm(csTgxafT zp<*=jvGT^>=d7MJ@3wHpZ&myxez(x)?D!{L`V7a_hY3P)+<1k0^WutYd)pj?7gjv>_@n7s)OM!4nraGzgiMumKLP# zTa{jxK-%Ob5xTrVjx@tBglmY5voQ=Tgz+9C<5v#QU&dJk`?_UMw6)J(1pBUo%QP^u z?`C48c*%rqXR(aQV2@lHrKLM{x(!Z+)QePflZkD=zD7Al68JhyBsdGkn4rj2tf0 z6K3WpGN%&rsucoTGh;<(M(Wa!yPUhp4S5)K(#UVz#LD zicW0A1P8Y%HX}RV6U(6g75^u!zQz6QYy~IQs98O+Q_bp$UGA)AooJQB;E8sZWsE#= zMD2V}9DAqP9Hm%>TD-+$XkeQSGvIp+BW)U;OCmtL;X)x;H2nBV7GpH?7GiN)xCT8xN!}xCCkeyu) z)nKvM$C;}VYiR3ikWDi@l3K9k6uznP1 zo=Gc1bs_TtR99Hl<Cs7*!+YuQy?meZ%Hl}3De6L`l+*E zdUQ=M99-`lrR+1mIiCyU4%=fjjH@BJCgMt11vs%tn=g$c70(@UjHwLove&Dm#*x-9%f#9F@vJJl11QZeLSIOXeYar#aOo{au z1-_U^fiITgg0Cu;ZtI-0-UWQ+rV04PiZE)NqapmN2)~^J$TwCc@XL;kao{H#n!)gk z)jKuG?qV?fV)GsNVW&6@{9>#6!LJ|ra_qgqgQhxJK|eOAC1jD5iY-!SMG z`>IpZFz6SfepxiM*tiV`zUTXaZ!q=78g1~ssn9RRk3WEVV}DWT7yCyN_~M=+(J$^( z;EU%d@Wpdo@Kwb}DDcJ0-UWQ+rUm%HP4u1N7oVo!7oX+8Zy5B8FLi1f2L0me-yMGO zUH#xU82w_uQSgf&5t({NoR>laesLZ+=Wje2erF*_=TVS$7GCBZ5x>EPAFqH1`oRg* zwI;;xvf=lscZFY!@cSZ04QCz^ph&(01*rHXfnQGi>kj-xs2@ze@n@WxhFLx0FF5cM z>1fE+H~y=B@Ph%-U41$Bqw!7~es3%M>q}Aa>+^}oI-+kRMAnGyG$LzoU(S$7*jJ>0 z*jFt;oYObTl~$|zCMY2G)eQ+m?py68#0wbq&Be%}svq`@Ro`-fVP4-VX9XSx2m7`< zH4TGnu(aWMWb1;f76iUszavtf9Hz;J5cCjrBpelWakNIuy2 zaT|vB*)U8x-&5K5pbf)^-xCac&Ue53P}FXonWndmedA>v<}2e*5vapRe2U z)k$|;s6D!2zVBbR-}^b*qvkJ3$F)m5S_XG4;F(slmI?^1W~=(SY93>y%_6;*cHq)F zEbYgHEK1BiUeBl1nCFGf)R;HPRM(id+rM{9z8dpBJN}@Z|55w*$t4@iIK|m#Va1X= z^yPe8oe!T_z;#ymzyKX@K?FEhOY;_N@$yL-9fy^0s~&E@O!MNL+%|ll7rWE|?~p?U z<{f4qEB*8EmC8LG_?iT@Yl*6OfP>df0T%E$j;Oa)88~J&pSChM0jKj)nsgpIF3~#p z8Ct1ex%U{~;-(+xZ9aUb3|}e9l`g~ZK$MI*ym1yCBn%fUOb@tUm>+VJ#hE+S7b(1F zr@rY+8^-_jx|N;BO6&a>>%Q@i2n_zGt}9II`$1s{$Ma6(&cb@xx&_UrmvK(6Fu$Y7 z4L5>_d%zdX-+X5Y zzs8=D&*Dd)!X(0^NF$Wj+B%2oid-?G%9*Wf;%qjp2-!TiCGIJwC=nh}tBZ15$)(H}Vpt6-W zwKV4%XGG;EQ85KAW-%~2Ie9#++DeU?Di9g7EPm3y*k$ID9RP?qv{2`;wj6b{4wR%h zJUEl1#w->ZX{vo~q4Hgy5rKr#Uv7R9s4-(y-J}0VjQem}}c@@|h-mg5#B)b{XzLRIY7H6QN?U z?*yn)zpfXzG-~Dttp%w?+SDEJK5wYkGCWJ`VPRfOGqXI*NAXE+@IN`C`ke^FPvfag z@6yN!gYi*IgdxVqDawye3gCut&HQq_85~h@J@bCyfDg&@RhJu@Kbs4lxRVJ5kG`rH zqu8b6v!;?UR?7uO;v$+&im=(Ca7WNaHW35z7(?UvNZy8&$1evb0PV*&3A>mb-{P{1 z+_+K#2jaV3c99itv4?O(esgRSS9biY#Pj1Hu;1SRd6m9QC#-|yC( z7yqi1$c=wnen-cjRc7Y+bMM5L%9Lh#A$iL@au4v9v5L2VL)9n_1s+tVc+g(v6Asmn z2Tf8uXg6-#)JL+GE4k)YiaTfgHx4}t4=U03$(M7X1ln#**m$)P~|LoL!r(mg-(}+h18RA2!B8!n`bN? zf@gq9;SyoK=x5g8vG;Ia!WYEl6xajW-w%dtXR`+36yU$ftU)|bg*Av9>L|W-Y#`<- z#}IaT`i>#F08V(>bnbEihxYkNGW8Z;`b~s{_N7sm_T9IO6Zs%+gIY$B&iC{RL7s_M zkv?hQ$_haxEnPnL74tLY6Z3wm32Bs^R1_k~rn$_wkEF=9qHwITaBR z_12TqDWZOBrQ*mZe}0*oqu1>@dP5js$;r2r?q)eE@Sgk&wr9n9w(akO@!H;^5r#w@ zkcX`BU<7uWFx+G|TZ4nL!e&opD>i#7CyC9TDwM>)sZwM@-|3BCcxp7f6LHxywo+Oh zQ-Y_)rsGSO^eD6kU3_Y?6bzl3mc|c0*#+mLU=|A&YLisKg(wIPl2i~rx2Q67YISnK z9ViIl3%B@bwW{EiD45l+VAL*nKo#Vm#+>4(5H)T7sa|(bg{R_@n0@NB8kEX;lb!RH zb+eG21Kii%8hufLZX zU59w=THXfvRz&N;2e40LKXDK6!GC&bzs1e9wu|$UNTnhliykeIkQqx!N4VL@79l0` zfU+V?N?9y4$!EJIv#d|@R;n6MwjV>ghWzn#w*xC#ETvZ2=CDb3Rh8;QR2GZ1=vdviBG(s@HM=44l>%Sq zz24|RY5%t(&x?o-H&0tc-(=gd6RYp(r-oU5OA|7<>x{6=PSg2OQ(KO9^6B`Fl#?dw zur!LH+xbQ&-bx8)^_>oAn75q#nImOSsl_U3esvO`U*>a017zpPg_ z&U{`Z1OJ&X_M(BSNPg$8H0 zxFzz=?v)a`XS?Kg{MjDmYIpX!cR~wycQa1yZouS+*{kp-hQL`KqjU8ovR8R;TavT4 zrE#b0KYM3C9Fi@`fb9qL5JT-eR0r;NI^ga+q`2VKFdGbRXTxXd4ko5em)Xe%0}l3s zR1Aan5sp9I*%#7>_NQ~U5ksp625t&$e>y?551x6O=(w7jf@ft@@D~yLOBH@z|NYg( zo-3|@Ug78UFUa(lU;nb=K2+~|uYY|RMM+PxC^?7^jlKT&3K6eYj@q-Y|5p+so>O8- z;2ecXN8CG?Jy1?Omjm&qpPYEENa5qTk*@d?IyXvT?zu5Zn0roX4MXSZUCf<)Zie#L zJIC9^1{lMK5^BaN=WQj9)YCwIj+ZF7Sm{b5K}sXT$PwqZDug^o7i(G0MIARlZg?ji z$E!gC=h~gN2dwVHtji>V@VVGvTy&RZm+#>O#efABmtu)a-?>}f)um53pwu9%W7RHh zddByPJ>jnF|Jz164J)B6a_7FhQqb(&BMQyVJ+5|@51;!Z*x<-&#rn#KZ0Ej%BOnnS zr-QL6u~}d8eq{8y=MkJU>y~ zJpJeE`(ex^va10stlwIw8e8l%CU^oBOR_dq@;jm%y;sBMHx5P-2|NBG^*woA8p6Wz_jkD`YvZ_GGiqC+*2{&#OII;Jm#jBZ`hY|BSS~ z;QaSov?@CPBS{ROf6+yf3Flvz#D(X7<>nl5{&$j?bN-KR&d~XPN@Di;eT&ki+SW_4!3UD#Eny%I3WE5bw%F}hU8*CgzEL`4JJK2E^KpEj0w?i(^#`$}jXTzfx*A+6K8*(TW`&)6(zwqQRC)V73Oj%+_BQz`Z zqoekI2fo(Hp(^{tS~;pWZ#{p4bi5J!nVGeC%;L^w!B%kc1=ED-=UjM8Z2!Rve-K;$ z_6v#)hcEmSmNL}v^&74N^N&1i-)||KO7BH4yk&~%>nqa&oq~P0{9=zH z)Qi`-6kc@k92}i1G#t*EplxNr(8UYj#L!+R3YJ_{N~-LOx48vJT)YoA>J)2mu^*+a zWWnrY+rz(u-e`7Q+`GN#mz6l{)U?ljv%MT^*^-R$YA>U4=}WC|LY|RdywC zRae>n$K%K2@pup3hU}Z7fS@3VB7%w_Dk|<zyc+Gna6|1HyMQ!_P{&9u)n`~1J>+~4E(SR}^}zWZD5y}!Ghd(OG%oO{kui7p*S zUo&t@#?g10(RLZPeN5A$PjV8;`(P**`9gQX_cyu(4F*+69l!StD)Hc0S z;Z0*v(7#i0P3dwNnH#ekI0(R2mA=r84qZ;~o~XVcaGU%UZd zjHEA)Rp!bs-iR+o4foVcb=`9-2()0^bUs`*WRC##a0q~0p3$xm-Jy-A+boZs}6 zF;huRFL0evO)nb|p4B8zYL+zloz#qLk`wJ|I&0+2Yx)}(FKhaTQDxgN&S0 znx#oVY4aE(XMD3X35aO+GYKee&gSBan{$ku+DnA=Ec-X1Lej$un~-aVWI!p{hiyTvBB2h5|ZOUdI;G|4fynxOcIrz=r! zLiC1HY}&n@PLD>=Q3THLbuPhPtT-Qp z#rm@tss%Mu1ZC9B!r3uI|HqT$K9X!4K>q>vI{l}3yP*HvsxfRGO12Ol%Euz!I1=$@ zC*4H0OSK1JoR!AizNO``_)?_d_V+7!Xb~rE}$zO z8|H_&?(SrUy395^BhEM2kpWp3J%J_zn&k(o6jKl(lYEWD9Xo?5vJH2G}^dH;Mq z;k;1`@S9!&xOU(wW#GzJ0>%^r&mcY4nOdX7GFGOaT29(@aZ>7TTZmFYSKA^_3zW8m zO5JTsn4j*p#VK{SEgnDJZA+xQ*@NPTZvGS4SATWJbF=xA8e=d!I%N5waj26+VGab zQo7&JqU-Wo=IM-g%Rj()M?TSydLeP<-F3^dT;jXaIXs+=C>9G~bgl5nd~#CDM(Eq2 z@NGE=W-OkVu{5QE8O4@EV8+0s8;oL0J(FNZ%k>6_6W!8@g5#-Rwz5eU>_$OgOuvG+ z>IF~u7kn562Wd`QeujenJXKta40GaWdB(rsM<@tGm0&QBpg~Z;w0w+$u0davdw567 zH?klNVqB}j+(K$=Q1E)(C%0OMGYiw@=`N7n`O@EtXd;S!YBv#bkaVa$>1qxUV^)t2 zCB_wkcFe8uK%?L*nXZvZ6zEzm@tiIbR1<^LnPlCDW5bN5&S4zUI+aKyDt$6Kw3L&gp@)PUbZ9R*|$AOj!5!N?ChlW2jlLV-jI ztz;pK01fsF1+<|Ud$U>pOmt()@Sua-1aaQal{j;auJj0*W7v<;=nl56y4GT zP~q?Lh4}%NosGPl6Iy>KmvieESR;eXFj~LD8i5$nSe31k$#=B=+i!8Tg`wae!;dxx z3Of7?wnfV2+!kjPjA_fo7Ac&zNV>&{qb(0xB>#f(ZG~LW*;Z^6jBdLWUmRrk(RLZW zILPp$ZMXi#EBy-|LBT-?r0qHs9E3pHj_L(lje;?4x1ygU0ZNIK zCXz}oBl5Lo*W ziNM;g_d{UqH_99Gl_o^%!$4r-o(q9}@|lsjZx$}6mE))IGP;t;Ocw>V|5PHgc6rQa zL%Vc`=4wBsTNk#!MaazGy0HCMz-0xdDI-`HCbYl8jgM=WXOG9Xe<-aB+edKyGMaT^ z``-XC-)mji5fq$+K9_e`zsI_;gSJ1*zR$X_W2}$34Tl4tbz#Tk^RX`MAh`!P)DDtF zDoSZbiJZ%hGQYX(SSaVRW3k^{b}W@QY+WeY@AtDVba$+iV%v@lQf%9Ckt94FTXn+I z@feA1PwD6L*j}MymrrWTM23GxCNl9I2PBc{xNax{?zmwn0`6#*2)Lu&K)}%*Cx#Wg zYgoab=mmf3hk!eNA>}#U4$^1L(4F27#(4De8xIrSI3t?n9OQ1=QRXFj)wHuXrYr%RdEA`ptaGE8Jop) zQUE6AvJ50;Tnz`#LPAnFYuA|uA>t`BP{M3y<51A+ylE)tb+$^- z>+JFaz0MQdlJw4dq+Yr6zR^JM8~~Ti0N44XZ@$kD%sPL~xY5=5s*f%+n2iQktW)m% zz3)5U%d-;-aCLq?9GZs1P>v2mT>((=pA&{8|9Hrv%(*0y0YYMxhqHRmb<1&sOg%iLrvFyKux4S)O3~k zHp`=6x}>gU5^B0G9tt&Gn}KU;9JN zUv#MXn?Kb2(+_HnbY%{Mnr@Y;V|aIP3FDgXPzg2N4xLJNZvoVdIkiP18>W)ovA*~b z3^tj>@{Wvg61yiz*y)}&6n47vhr&+xYzaHvrG8Yhy8;EHNzRd?l(C$ndl?GG_;1C! z*Xji?^aHx?YVOE{?wyiKc8}mi$pE@6NhL2PDw#|whv8K6I&kLQ^**p*@QWfUnX2TF zul%K>Q_1cYNhP~G2LU3}DTYgyRF8(um`Zk&ZybY4a&eaTelL~mequO;;%u`X4{tbz z^HIs}(;-pkhSi;;P|5C(CDeA4QVmes{bvca-Cz1aZTB}4YPhNy9LfEn^AKC!H8 zEEsrMuWl&Ui~V%y<9p_D>+L;D`6JVNK%Q5_EgKelXv2i z;iqiukr6dLJ-?KlqOs2Fd6kQo^}KH6Oze@?mXSU08#yz3K9Z3udd?2#5sX9ilT0PL zCNN8y++Yc2$;cGAsx~E$5ZA)c6v9q>owyzgv*%w}7noYow}FRc&07@d+ps!G*#l3r zeC4LAO-h;@S~lqUhG^r4M|JMC1;bCdlG*D79^wn`b_55 zq9d-}B|bC&eGMNX*3EAWTwq)oiWlR`P{FL$&oB7Qbb2of@eh#69txP1Hgp??_QH5( zXfKimkO^x(QuF|snP|6Y>q(@|-G^(idgpkcDq!oJ*@Ow8TnJOvkm_N!ZijbllVpL8 zZI+1P*fxn6UOpy>1@iY0acmD*pcGU3;4`^N$LO2^EGLfL$2FuLdq{eSICgS4Fe8>I zfp7)cisiD0h-1%T@-Xcq9XmaCnmt5JJ@z^vijR0Ek}w$Iz-7@hC<TBaKr3F&?G- z{@X?zrT)876qZyYjZ#0wwdCy}AD#D|arKQ-|EWQvG;7!>9qp%(MdHIUB``oc&xS^0~rNSzW?f z3rU}%&VY~}NeL8uNETpyKn=ALXUcJR!S*QQm-%X)+-tL}x z|E@zF@9zIm!~NrMFdvoW!UGnPe5^4fh4OpF*yQ4_Og>y9v#g?HDT;dG92p<)P{3o` z0^pQKyDhNpy8JEZ&L(sx%8c$n;uKD*QxAj;M0TJUB9s+FFKpx~#zwX!V?YqOvspXs z@Ce_9K}BT&w>|GSw99tw8aeblb?Xlm0bEH zsrZ7EJ_px7WFA;+3b@#8nW+Srcbk;8X3I3CNQD!ibhVa_^VY@z0Aj>bKnL?E0@q}< z7O?P)YKfx)c5zfuE)uWVBa~3c;zg69TrA#^cL|~yxVlq(jL4^x5C$+%+@)I9Dsfg> zZ=|?IQMMzDpPS|aC-YSczNhX!NX}29wJ-$9n`*{UWHbRWHLPekRuYr&9BwOL%` z9}$Xla+}12CDDR`frAPQ!JZuy5b+gbsGEsa#3W=XKff@m7`s>tdT5)C4!alE1}f`R zOQaHJL0PEE-xNO!F%w`uw#^SJSMRGnH&i||-E;5{Z?;BHDmS;jf5!`dseI#(mugOX z#)(!KUz0&sh{Z+qr*-(W-Mc;n_@2$C97#{r&F?14G{b$3Op* zE86f`yD~E;JeBy6U6P5Muxd_b?*)7-$_hzxibQ>u4M8Sz5MRipET<2m{|GB% zmVFyT9pi{r=h3_8f;>O|?%||*@1CIP9l1Z4cI1VZZhwE*{6wlUJ3LYLj61~~9_yPi zxYQhbJ_sawQUv)idNLOl$7uL`93@bcq9s|O)WlV?h4d(IqunzQz^Qo4ma4sbckMan zs6W^5Ir+yQ-u&KN+w$Y)?{505d*+94Jdkt`(Uxgxgp3Ixu}ReoxpR@UC2JBei;_sT zzj`ZE@_Fo1ilF*al$5zLC}oHQd?5KT18pkVwS9Zl7J|!jw(9v@&!t~vWZu!V^NQ}r zFS@FG-kIV@-Pa3`Xh+>1Wnor`IW$bQq$&YXwI0#I50}pNdq@MJuEf3!-Pphlo3hnD zPjmu0x0W0+U@ zjj$^ZydwngGwd$@%6Wj;3)?-9oakFIMIHaci}pPH&ZZ~E-uY=>$LBm0)3`QuW)9yK zOA=j@#jCXUPV{I6J~nf4_!!bJGBW|YCmIaIehpDBAWR)a@s$|wEm1AW0pd6zxg0a1 z%cW3!Scr$obOJx?!DRZN!n!AoR*gk8W?X{Qj$p(qK;Ruv%7Q-09|W<}ui#1&#E^av z#12m5^cR8jERZq>(z8H%OUT&w!_W8!fz9Z1`QpiOGJTfQYVj)^jmKz;SDmn&p@!#M zIHyy5kU}{_#2-^BwTaKh(E+UtxW5Yv5Z4j0Pc={Wfy&-3(Ht5vpWJ1r79kAWP!}m%%DFB zM1-)c$THOm(V}`-zg=UtBr7ErkmL-?f-fg4Q&bE-#=?%kSL5?s*ys|RHPMiw|K?4(S(hwLs-XtC;l|Gz9B`D%X6?O`UE*b+6LwVF1fE-pAZV&6X z%#(tf$Q8YcQg#h6$ShM%8j)a|QW;F4j#)aO5_~umQ_VoEWS3)gK82E*B#vVKdHmL> zwPEDpD_jXtB^fVN4~J1`b-2MfxJiX>Y$lu@SSx8`<`lOf^f{LsZw9Bc*&?Bh-g(3W z_AyE}Q8fggwowIAZ< zKv;L3ub7}7wo`O77ow^GSSC=JEUF!#8Ax#AR^kaB0ynHuVbBb-?YWs42H;%rkI6Fq zZxW?eO--cKu35+Ob1fX=R^-z>IWmo&D%0dCGM$ho(+m#kq-xoj@;;9diK-Ro_p@^{ z#Btc1X^TN{Fh16Sp1Fysw3FvR!e+!MtF@WpR^kG$#3+EpwkXrhKxU$jI6J6Y9Dx^8 zH{CW6H*BHii`#$+w3`Q*a~!r*Yl8eac#GBSIAJ73%ma;)72XelJbxY2@9 z=f#+YDAYa?enlw6OH;F=gL%K*kpitgH_+WLgGM%;_lZkh6m}Wth&3l#*rNmrgBL*BtTtLwj z)81@QZTtl&nXZK)rmKlHhBq}>08+yNn&Aqtex#DCB9xwKWgJ=9CkZQY5#Vb7iuSx4!C9x%FK& zp2B#D$2WlN0*%6n8!bG@y?N6~UQloa(XE4aI?PTIL$hpqxC2wOpRVWb3#Y9GUr)O_ zoCGZUiODR?2!Z=c^0Yc1*pac}WpFs_UQ&6*AWq?&{X9L%b97?etED@Ftp^rlwEy** zjh)ZsT!rP0EmP(?5CQen7WzLV3lYlfGBDuG9biWuMa}}Fh#d$H6c2!Z z2^0@wyA&wyBO}*xtCA3iO&u=95evA1=`0DM;bf5{fO@hxfnDu(EDf`XRy2{5ZQw5m zTmf^~E+0(rZGsD}8>o}ks}KqiSnp~ey*Y&Ra{ZAWfuSm{pGfE~Mcm{=wiC=iQx!DL z6KTm)o_iQ0sp2W7_>08zv|N-G;$?|p#4EWn-y7*N{hh>2;=}3k{!@v$#OK*`Unc%C zhtgc}uVPB`wIE&!MOvs%_+5TWK#R3+CGR<*+PG1$OO*96W0weJsTo^&Mm+-}0ke*J zMtm7*E#a*`#>=MWgt(Vf?Ynf>*7G30uiWLCTfC!J{p#0&-!_N#-231Mx8Jn*wx80t zhvzca=**WJsv=%S@pDN7uEfvJqB+Ui?AyX%7Y%h9kwr{0<*--tM#Z&rQWh~hOZFgA z7J$G)Y)CSpJ#ZxiDEzF7o~7v=h-2x_s$G}(*z0pHnpdklKMz0iW^H5cbq9j?zkhwf z;l{+t8>_J^QmV4C#<6Kfq!wbyfa-#kl>~+H#3uq-4z$u$l1nQ)lH7fu;Sp$g+6ru8 zAXQUIL&en6Z*393bEk_NcpiiMn%VQm$2M>NVc+(r54K*tFV^$-Z}*EgG~#V$=7Hzt zZLQq=5lCYwSWZF1=PI5=$(TiQpSp?%)3J>Qzi5Zt{OywfM)~p%*{6!Tpb!&YEUk&A zOt@Fqm)2Od1_88*!7nVH>!^+2V)9Pc-{@jRj!pNSqX+>>`>}rb2Fm28Jj* z=@vVrsHJV7+MVO{zGdB?7(9Ey z`=3#h)hsC~%;J5mI#nX;sTs64N-w|!&ZO0godvUEo@JF=Ea~ht* zM-|_^{#VaFS3&T&fUjm*|9PV9{jD|6e0sKg`!;-d#v+i26tC?7&bR*j+3+9|W(3j5 z>OUBAgyg0lXrV`W!EYfC)HB136iON*{(3LQl`)`fTm>jV0Gx|B*?%b~Yj$(8K{~1t z^)-yI#Luqbv{GElsj4k6N`gpsskRQAoOEKMZL}DoRdC045`=+KA%thss`H~(R9#U; z)cpMD+#3$h8S$s<3SK!Fb$8ko*Hr%N-_`%VjgSVJBKAl9jawK^($C~3DF{DrWM>Lpe8`sOuI|0vk=I- zaD;v~9dX}}GedIW^Rr@lhIwaPd7&ZviK}F(Px2*F>Jv^J-HNJh)qD5tsXZs+ek;-Q z#q}Rs?tHO$*}l8KwEl8w%g&TDx7^A&VNxcGOgjK|;Jv0`wNBBuW;Ssz7>8nr!yzH2 zymOY>CyO7$_LM?HgLN=NI!_dxXbc$OF=`Dk-l2gFS)^qnm0GwLxly$sKZY}9O+}OP z0h0D0YNMC!*@Zw}`)Y|p9gty-94z3iGfygSedftMw(v~)U!M5z z*r%ue^423~-a3Bv)_FEUunBosS~Gy+`KCnP;5-8(7aFtksQ>Mio;wdd^x^6aFHHXW z!-xJ)tb6O5ncg2|QlDl`v!{ul-~t}GOPn|Z&qIKdvq~s!gJMYxKV~=BeVa!~6ZgrC zn~)KEYl_|p!ZB|YRc4C^upM3k z3Kc?y!w_s+Q4QXaGz?IIm<}ZXIHB{fY=|Jl-T$c0hm&Tg6HuZnkKUuo^0Uid#Fj;5XQl#Y6Ol&Z>_iZ0jHe2FQaR zX92suIPowA82AxlrAMn4J;Fj139_&kh!l@d@u%VcE=k1}gvT{mt<9rCv&GAJ?ou($ zCA90DMp8Yn8PqHgL0VxJ{G%%ZeZe40B^{7g{_#8+rsu>b0cQENQ@ zt1G|)g&6J1weEfghykTeg35%>%V$?RGjZP{s`geMki_XY$)r+kT8j>I6T)anSW z2#5Q@x;X+wtGRYMgpm+D3>p&pm`hv1vIV=gmO1z=ZL@ufcodN}v>li&$N>OvWOl2X zCiJ8pt`$V5X9hb6uLs>u+?X`0n>ka2^l-=v(ZI;dJo)kwQk>ia9$a1w3ZI~f> zz%)|JlDy-c+%js1>dj>5>t^rdg?NdOs1>k)+)j)%w)t8){1YAo2*`bL9I*MmU7Pn` zGH>^OsK@rzGOpiqu0V~14u1EjXWidQ9(>`^wQ+$fu6Zvh>#wf-vv=eI;i{!mnUhjy zgOcKQ9(HR;7Om%G`8wiYQ)jQYDyg=^Rwc^@u*k9<_6Y{GLlG;gDz`4(xxKcun$;nd z=OC8UiucPr7cMQhJG5fyTiuD(VJGifvv%#DFZ%(J$3kLeeUeN1^n^TaR#E{cp4rTv zOpu`?GZym0F%|sKvr@iWC6o31Zo(!`61Ff+AA6}>kyLTS4$f!WBeU0VzQn5mvx<@> z5T68TtT@7HJhWzXA0wJ{)%<0wo$quE;uX({g+D0t{Js39r@wok`%hoK@ZjS=byiH+ zcK9dH7m6noCA%D72GeYZ(%dqJP9or_y$R}o5EXJ9tj!Gdum^h4$tvLd@({&iTh8*5 zGI0u0z^!N(D=(o%2H7J7h+})I)cvBcn-F2_A)xDM!mUtC2S7CFK(KJrp%8FCJC=(l zvFN}j>x(Xe76g_j4z**iX##KVz(k`cc9>yOCo*5PM4)x1Kx$nw5jeCCBu}{8THJ}20pbHmE)`4|66;i#$i_)cudhd;mP%+!EXp476gA}uG=&#mA~gk@R=qt_ zNSy#tJ>LcoR2HoscKZ!afMtDv5@L06<044r4GiFs4Tr$jrUdTCri|Mf;8{+S>JcBg zNs;dopEv=}P{dDA(kxh@;Y?1{-DHFlCH@8og3vic#+Z=1EOmFBc$#Fffp|HFvO`+H zv`)SI)GXaxB(9dNfRBbIgWsfW+qJ5WDZN< zQf6gGh+hAkceiXsUKEuct^vpBWcGRPzIYZ2FYOf{Jp(H+jGkrtvt3#0;Uqa?fwdF#g#)&0GSyS85#`UOj{CltLIBA$ z$H;CCtDK0Y7JF6X#vt0sCWK}gd|m-Ey6f?FXp&wE^ifp%Sv#CjWA`4_U@Dj5|S3h<=yLB ziB6pi65dQKz^-3W_DlmUg7%6Y#g{ts#B;d7_i;Q>Jc8<1o8a_?yIKqY!`555!V0w< zlzRY`XaWSJkl`!JwfGN(hH~BgL;wc-h+CuR3;tCAFjz5$mIJB-Z*bn)KHF;kGMOI8@oo9f-|w2(H; z4%k<{PP=AysxeeAkjoj?4MmGH8|dCCK4INal=x&5-8;lLEQyU2->jAI|HCXql=u(d zyR;C#kJdug(R;V9a{@DZ0o{AFM1CKuCGx#Xo5=M=YZKRVeOeyhM`?Ln-lfga-_POq zZfy}uiet1z+&+)ChTq3(Yxv%!Rr332t&;0^YTNlfO54umU0RLopH@Tp1GZ_`GQXXq zUC%n{DcTJ&POOm>trNE8pl?tLl1>XSp!G*UOipq!Cn={f?9|{Gtv6*n(s1pr2%T38 zQ%!at<-^i2iR<9zAMRIul=e%#`qxoCq-QwMeeUWr zv_HhrXVSGl$55K1ea^i~*S_FU%F(`xAy^I8zMK#Y;BZi;eC@w7lUL!PTI@C9tTm?E z8;}+Ppg>L_QOX(OJzGSn-TUoouEzTNvMl*@|J_j zsdb4w*lJx0^Pg&6`V`7Escy;)5^3rzUt;Ok?Z9$@^_Y`3GU3Ezz^fX~C5Rn(73>rOlqqCu z##CFetf;#Y3j%DcsFP7|)w(yh`LpZJfFahur`CNWwG(w`_2z$>MW}Fn-PdR%^E4}I zKab51QxNJ}THU{)a|lrLsB7u<<_hi_s6F(nv}Jv+EO_G?3}#6_lhcT0%+2 z;&Mu=D)`-mrI2D_Ke}uICF#p62r^fQ`|Lj+8{AtQOPMm~`EdVTSPHU4m zCy~-JogRaIVyzqZP<$bNMTOpThLA}P&LfhQ9#C`P#D!z$oa;zi(Etqh}wOeUq=jKvP#B?ykxRLevlRG2Y>eF{_-5*lFR9Ee1M zq=Y})iv2ym$fU&%W(WhgsCJHcNl`Xx+nr8gqvk6%vx964!0g}$UDL1hXQ6bWC&unGLtvG5%2LK0VC2&1BjUZ)j zuo973nJa#cb*(_|i-~@&C7={U= zzaZ%80ZZJ5v1IR(K;b9R`$7_!Ahv~CdliNXS56BCh^-)y8)mf805OO_!KO#j!psn- zA@0!rh=IcBBPJNDAV`7(Lkq;Dr14x!&wxvb)%9rK0aW=NmT@2%O!2$f;{Wi{8;F;T zzZr!2B{v1y7*_OV%|g zcWt(K6^qoH1^fW>g>*=FflZlV1?+>NCDs*6mQZ=M52m`}HSFfR^HBiHf$53|aUC4I zfRLBq6>BE|+&gBTuNE^G0)4J{0VZ7FGsFo{0jymoAwudrc481L#9=>!>04_)7zfP_ zHad6~iGekFXy4;j=8&l`N&;TY2QB!(Vd&O~=_Vtr&ua*mgdDtxlhTXmsZG1KiqgO9ZH`*9}K1nW(E;u)#A?H zONni{{DgR&D-HMN@!RmjoLDzkas#wI{MK4m%lF~+doHKvwubB~s>E5ei*6m_xgDHp zOF4CFZ_4N1N_p=+%lF}Rd%3u??qBkKeS<6~KAJ%2I$V4bPnNzsG?C)jgH&m>R?G-H zqAmqn2JE(vOc!-@5p(1{q4CA_B|_t@*Z&s_5M;0M*W!A*h`aG2(LfimH#LYl%Hq8F zPyA_5%e4J;?`nN`H>d6QbL#9^&F{x_u4R_N)0N5j+}#0KvS>|DBDcnKYy&@!>|cJ6 zMq<*Oa^g$lrbf64ecHd%Df7rrYA)H;;9n2~z>hllrG7t8oEmh$ zP&|wKyn*}+#EZDc+NI9riPzCNR_&s56Tvb@h4u?2`gUWtHNcMA zz4J1tSgN-y$0FXus`buK<%=Zmf^_2SR(dZ)MId9r#G`;<(vMzcnD-L0dkLK5eE@kP ztiC)x7L024cpnG%3~c3ng7?05?~{x;!@N)N{aEjF-0-p97degfo_5XTLx5Yx)NZT_anW=vz$hHzmPSCdA~)Cyo?}~aEwr6 zf?DGu;k+>qtEuf-;s##T7M#_id#m{LLQ2!U!EBpSw#FGO-iBy;Jukqr&H8N>-I}hr zoS!b*Bk!(~cZZ$h#XG1Y0jx)#i#r9*C5blX5YagR2bY6JThpAPl92|is=Jv|#ZlLkhBR<&U2_^i!9?$~_!{=fJY~tm=tOvbi%k|dW!Rk)PJlKu zK*|)-NSOn=@A3XV0y`rju4%-xU{6i}AL0EI3W6yj9S=khIt-+H|Bl=s8}-*NpmbGz zBagbPzKOvtvc45!VxLcs`W{e2c4Y`|3z{MNDJ0?zktOXF4^b6K^>>C+>!a%*0B1VL z*;)Nhp_u{uOa0-zarKY!XB_oUh8n@@>R(1d#MFhTOv$9G!s~y7f)HH!75uGU@Euu@ zzU-*~13z@ue`FuX8CCz8p7YDlfrqK}e+h+{NJ*~$N9eFH6o#v?28nod-% zqqBnP9KEE$g0V-F*zXrqpyc-}Mv0=B5>V}(BYH`LCv+A*Yj21S)jbCC4mxzeI~S{| zhWOJTbQG5$*4~im`!;*b=i>Qv3U{>VB@MICRX&BtCv@4v7JG$75HLu;s0kbnj3eQ~ zO)4Zy`f*y&Va9b0t1t_o%m~Uzn+r&obYFjlTP$p(^;o)SHC!S3M=v>2Ul#%=bQQqL z+0uJectg#6hPsA>66zWR&()ZQdI@z&_^`R55w>G-rb)W*J%&1efJl>pap>rjAe zxP2(VHQX(sq2VWf0N3#NP=ITAVkp2hJgXP{l>u-Q8h#TBilrnsymo$IG}W|vB1vHz zKJZN-g6{bPPb>k?cnY2g-)S^7ISqf}PuLs28VzIy!3an3IzqUC;d2O#3_5{55ub1! z2_FqId{BU0H$%aZL@1}v2?Z%T$hS;_j8{|Fu$N|hvEPh0hAyIRt!oUIGv4UoVU1~w z@|*F-M4Z8iGl7vc@QnYAk84bmGv1gtbjBN}51sMGS#shUOZ;ZMaoNxrZ(K2S#v9k` z1veQpKCy9&obkp>|F;=$-0z!?@15~RA!od?;eVU)##Y}azIVnOZ~tFryz#;Fp7EoN z!9!=fw{I@bc<*g;#(RIj!|Lq4$8W}aAIP8?FV?-{LU&>tL{wsW9|QIVN$i!&a8B>@ z5Pj=ZB)XUE6tFSreMO>pCO^IJVu}a3p6GoKQ>=49lKk|3B&WFdtTDyOySH$khVz&c zbIe{BSW(ZI*|;6Ps*ff4KEaL{IY0XY8osKJW%=gV@PlnQO&GeWkIjao4r5j0+QxA7c9nJyh!(M&}Zf;UfE}rQ`{Hsj7QF;eVNc;EG+|S@2=9zcbK?5HkuZ2XfGeGJJdA;7?s10!QL)Fz@I&|USP4;#iH@fa zrBcT;hEl2HIb6_je7YZ%I$k!EN*!M?lu8|6sux^kps;br*N2v%!^y`tjRw2pB*ZR& zR#G~fnhLGl0Lu$rWd`vo$9MSP6`U8lU?f%?rlQ|V$c`W2R%9MO40z?jjM^X@gnB`0WDWFhqzs?V>DXFKzsbeAfSZ-2-tICc}HS{eQ43g@*Y2FPaF|w zlLi3P@Eyx+aLNW^fU*zK?)yOhX#&+{=p;J zvC|_c9P7O%Vhkx!+53g=ODn;9ZM2)rVIaRIC2W$(>c&yG!}_h%$yV=%v2O|x+H%#B zL~?GbZj!e@B9adKaaL;hMczAkD{1rIHJk1$prfVKQ(wnoKzGAl2tc4NZwzMfUs!K9 ROD@Cu0;L4A|MYG}`F~Wh{=@(P literal 0 HcmV?d00001 diff --git a/Runtime/Plugins/Google.Protobuf.pdb.meta b/Runtime/Plugins/Google.Protobuf.pdb.meta new file mode 100644 index 00000000..e608989e --- /dev/null +++ b/Runtime/Plugins/Google.Protobuf.pdb.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: a5f284a854557a44f9588e7bb486fed2 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.xml b/Runtime/Plugins/Google.Protobuf.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.xml rename to Runtime/Plugins/Google.Protobuf.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.xml.meta b/Runtime/Plugins/Google.Protobuf.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.xml.meta rename to Runtime/Plugins/Google.Protobuf.xml.meta index 8e77237f..b357b512 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/Google.Protobuf.xml.meta +++ b/Runtime/Plugins/Google.Protobuf.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 58ec8a9fa45ed42449af39794aec3ffa +guid: 381ca362daf60694b860a7efcedf72f9 TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/System.Buffers.dll.meta b/Runtime/Plugins/System.Buffers.dll.meta new file mode 100644 index 00000000..7faf0db4 --- /dev/null +++ b/Runtime/Plugins/System.Buffers.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: d636a8a8db41b4d45a85ba6948bfb6a5 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.xml b/Runtime/Plugins/System.Buffers.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.xml rename to Runtime/Plugins/System.Buffers.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.xml.meta b/Runtime/Plugins/System.Buffers.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.xml.meta rename to Runtime/Plugins/System.Buffers.xml.meta index 124220af..68ff9763 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Buffers.xml.meta +++ b/Runtime/Plugins/System.Buffers.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: ee2438659f505d34a9803ab730acbe3e +guid: 03211042b3cbc1347a709a9902d48c1d TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/System.Collections.Immutable.dll.meta b/Runtime/Plugins/System.Collections.Immutable.dll.meta new file mode 100644 index 00000000..c2a9968b --- /dev/null +++ b/Runtime/Plugins/System.Collections.Immutable.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 5e43ef1150e75614cbb350870c0aa0b1 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.xml b/Runtime/Plugins/System.Collections.Immutable.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.xml rename to Runtime/Plugins/System.Collections.Immutable.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.xml.meta b/Runtime/Plugins/System.Collections.Immutable.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.xml.meta rename to Runtime/Plugins/System.Collections.Immutable.xml.meta index 4877371e..6fafd170 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Collections.Immutable.xml.meta +++ b/Runtime/Plugins/System.Collections.Immutable.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 5c47f28089d676e4e9b529b4e3863500 +guid: 409470105e1709a4d9052a0c46353a5b TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/System.Memory.dll.meta b/Runtime/Plugins/System.Memory.dll.meta new file mode 100644 index 00000000..816afaf9 --- /dev/null +++ b/Runtime/Plugins/System.Memory.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: de7c4337b811fa34aa9d3f645e073ccb +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.xml b/Runtime/Plugins/System.Memory.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.xml rename to Runtime/Plugins/System.Memory.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.xml.meta b/Runtime/Plugins/System.Memory.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.xml.meta rename to Runtime/Plugins/System.Memory.xml.meta index 0c9cc098..cdf17169 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Memory.xml.meta +++ b/Runtime/Plugins/System.Memory.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 8b5284224431b144f9747694f98a9adf +guid: 6961c034d4349a34ea369a36e89798b1 TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta b/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta new file mode 100644 index 00000000..78f7e583 --- /dev/null +++ b/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: 3dbb5f6c20eaf9a48a61825dd96f97e8 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.xml b/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.xml rename to Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.xml.meta b/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.xml.meta rename to Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta index 13f73780..6cf83967 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/System.Runtime.CompilerServices.Unsafe.xml.meta +++ b/Runtime/Plugins/System.Runtime.CompilerServices.Unsafe.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: e2ea846fb68fb824184c91522f505c29 +guid: efab8e74f1d408049a4b6460d5bc54c4 TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/log4net.dll.meta b/Runtime/Plugins/log4net.dll.meta new file mode 100644 index 00000000..55239e8a --- /dev/null +++ b/Runtime/Plugins/log4net.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: b9ffbccbf4b71034a8c36ea8966f4a4d +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.xml b/Runtime/Plugins/log4net.xml similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.xml rename to Runtime/Plugins/log4net.xml diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.xml.meta b/Runtime/Plugins/log4net.xml.meta similarity index 75% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.xml.meta rename to Runtime/Plugins/log4net.xml.meta index 949f4879..f61add69 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/Runtime/Plugins/GameLiftServerSDK/log4net.xml.meta +++ b/Runtime/Plugins/log4net.xml.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 339e340b2ec6fb143b38ea16b3fb2f89 +guid: e4266163dead1224d86c0b1b4c26953a TextScriptImporter: externalObjects: {} userData: diff --git a/Runtime/Plugins/websocket-sharp.dll.meta b/Runtime/Plugins/websocket-sharp.dll.meta new file mode 100644 index 00000000..75a8da5f --- /dev/null +++ b/Runtime/Plugins/websocket-sharp.dll.meta @@ -0,0 +1,33 @@ +fileFormatVersion: 2 +guid: fb00a8ae1d6e6954a8d44c0d0f140cad +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 1 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef b/Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef new file mode 100644 index 00000000..9f757c0e --- /dev/null +++ b/Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef @@ -0,0 +1,19 @@ +{ + "name": "AmazonGameLiftPlugin.Custom", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.EditorCoreAPI", + "AmazonGameLiftPlugin.Runtime.Core" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef.meta b/Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/AmazonGameLiftPlugin.Custom.asmdef.meta rename to Samples~/CustomScenario/AmazonGameLiftPlugin.Custom.asmdef.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/Deployer.cs b/Samples~/CustomScenario/Deployer.cs similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/Deployer.cs rename to Samples~/CustomScenario/Deployer.cs diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/Deployer.cs.meta b/Samples~/CustomScenario/Deployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/Deployer.cs.meta rename to Samples~/CustomScenario/Deployer.cs.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/cloudformation.yml b/Samples~/CustomScenario/cloudformation.yml similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/cloudformation.yml rename to Samples~/CustomScenario/cloudformation.yml diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/cloudformation.yml.meta b/Samples~/CustomScenario/cloudformation.yml.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/cloudformation.yml.meta rename to Samples~/CustomScenario/cloudformation.yml.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/lambda.meta b/Samples~/CustomScenario/lambda.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/lambda.meta rename to Samples~/CustomScenario/lambda.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/lambda/game_request.py b/Samples~/CustomScenario/lambda/game_request.py similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/lambda/game_request.py rename to Samples~/CustomScenario/lambda/game_request.py diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/lambda/game_request.py.meta b/Samples~/CustomScenario/lambda/game_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/lambda/game_request.py.meta rename to Samples~/CustomScenario/lambda/game_request.py.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/lambda/results_request.py b/Samples~/CustomScenario/lambda/results_request.py similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/lambda/results_request.py rename to Samples~/CustomScenario/lambda/results_request.py diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/lambda/results_request.py.meta b/Samples~/CustomScenario/lambda/results_request.py.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/lambda/results_request.py.meta rename to Samples~/CustomScenario/lambda/results_request.py.meta diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/parameters.json b/Samples~/CustomScenario/parameters.json similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/parameters.json rename to Samples~/CustomScenario/parameters.json diff --git a/GameLift-Unity/Assets/Editor/Custom Scenario/parameters.json.meta b/Samples~/CustomScenario/parameters.json.meta similarity index 100% rename from GameLift-Unity/Assets/Editor/Custom Scenario/parameters.json.meta rename to Samples~/CustomScenario/parameters.json.meta diff --git a/GameLift-SampleGame/.editorconfig b/Samples~/SampleGame/.editorconfig similarity index 100% rename from GameLift-SampleGame/.editorconfig rename to Samples~/SampleGame/.editorconfig diff --git a/GameLift-SampleGame/.gitignore b/Samples~/SampleGame/.gitignore similarity index 100% rename from GameLift-SampleGame/.gitignore rename to Samples~/SampleGame/.gitignore diff --git a/GameLift-SampleGame/Assets/Animations.meta b/Samples~/SampleGame/Assets/Animations.meta similarity index 100% rename from GameLift-SampleGame/Assets/Animations.meta rename to Samples~/SampleGame/Assets/Animations.meta diff --git a/GameLift-SampleGame/Assets/Animations/Spinner Animator Controller.controller b/Samples~/SampleGame/Assets/Animations/Spinner Animator Controller.controller similarity index 100% rename from GameLift-SampleGame/Assets/Animations/Spinner Animator Controller.controller rename to Samples~/SampleGame/Assets/Animations/Spinner Animator Controller.controller diff --git a/GameLift-SampleGame/Assets/Animations/Spinner Animator Controller.controller.meta b/Samples~/SampleGame/Assets/Animations/Spinner Animator Controller.controller.meta similarity index 100% rename from GameLift-SampleGame/Assets/Animations/Spinner Animator Controller.controller.meta rename to Samples~/SampleGame/Assets/Animations/Spinner Animator Controller.controller.meta diff --git a/GameLift-SampleGame/Assets/Animations/Spinner Rotate.anim b/Samples~/SampleGame/Assets/Animations/Spinner Rotate.anim similarity index 100% rename from GameLift-SampleGame/Assets/Animations/Spinner Rotate.anim rename to Samples~/SampleGame/Assets/Animations/Spinner Rotate.anim diff --git a/GameLift-SampleGame/Assets/Animations/Spinner Rotate.anim.meta b/Samples~/SampleGame/Assets/Animations/Spinner Rotate.anim.meta similarity index 100% rename from GameLift-SampleGame/Assets/Animations/Spinner Rotate.anim.meta rename to Samples~/SampleGame/Assets/Animations/Spinner Rotate.anim.meta diff --git a/GameLift-SampleGame/Assets/Editor.meta b/Samples~/SampleGame/Assets/Editor.meta similarity index 100% rename from GameLift-SampleGame/Assets/Editor.meta rename to Samples~/SampleGame/Assets/Editor.meta diff --git a/GameLift-SampleGame/Assets/Editor/Scripts.meta b/Samples~/SampleGame/Assets/Editor/Scripts.meta similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts.meta rename to Samples~/SampleGame/Assets/Editor/Scripts.meta diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs b/Samples~/SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs rename to Samples~/SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs.meta b/Samples~/SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs.meta rename to Samples~/SampleGame/Assets/Editor/Scripts/ClientServerSwitchMenu.cs.meta diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs b/Samples~/SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs rename to Samples~/SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs.meta b/Samples~/SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs.meta rename to Samples~/SampleGame/Assets/Editor/Scripts/GameLiftClientSettingsMenu.cs.meta diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs b/Samples~/SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs similarity index 71% rename from GameLift-SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs rename to Samples~/SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs index c83cbce8..50d834a6 100644 --- a/GameLift-SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs +++ b/Samples~/SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs @@ -4,10 +4,10 @@ using System.IO; using System.Linq; using UnityEditor; +using UnityEngine; public static class UnityPackageExporter { - [MenuItem("Assets/Export Sample")] public static void Export() { var exportedPackageAssetList = Directory.EnumerateDirectories("Assets") @@ -18,18 +18,25 @@ public static void Export() }) .ToList(); + + Debug.Log("Exporting Sample Game..."); + exportedPackageAssetList.AddRange(Directory.EnumerateFiles("Assets")); exportedPackageAssetList.Add("Assets\\Editor\\Scripts\\GameLiftClientSettingsMenu.cs"); exportedPackageAssetList.Add("Assets\\Editor\\Scripts\\ClientServerSwitchMenu.cs"); - string sampleFolder = @"..\GameLift-Unity\Assets\com.amazonaws.gamelift\Examples~\SampleGame"; + string outputFolder = @".."; - if (!Directory.Exists(sampleFolder)) + if (!Directory.Exists(outputFolder)) { - Directory.CreateDirectory(sampleFolder); + Directory.CreateDirectory(outputFolder); } - AssetDatabase.ExportPackage(exportedPackageAssetList.ToArray(), Path.Combine(sampleFolder, "sample.unitypackage"), + string outputPath = Path.Combine(outputFolder, "SampleGame.unitypackage"); + + AssetDatabase.ExportPackage(exportedPackageAssetList.ToArray(), outputPath, ExportPackageOptions.Recurse | ExportPackageOptions.IncludeDependencies); + + Debug.Log("Sample Game exported to " + outputPath); } } diff --git a/GameLift-SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs.meta b/Samples~/SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs.meta rename to Samples~/SampleGame/Assets/Editor/Scripts/UnityPackageExporter.cs.meta diff --git a/GameLift-SampleGame/Assets/Prefabs.meta b/Samples~/SampleGame/Assets/Prefabs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs.meta rename to Samples~/SampleGame/Assets/Prefabs.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab b/Samples~/SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab rename to Samples~/SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/ConfirmationCodeScreen.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab b/Samples~/SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab rename to Samples~/SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/ConfirmationSuccessScreen.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/GameLiftStatic.prefab b/Samples~/SampleGame/Assets/Prefabs/GameLiftStatic.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/GameLiftStatic.prefab rename to Samples~/SampleGame/Assets/Prefabs/GameLiftStatic.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/GameLiftStatic.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/GameLiftStatic.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/GameLiftStatic.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/GameLiftStatic.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/InputField.prefab b/Samples~/SampleGame/Assets/Prefabs/InputField.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/InputField.prefab rename to Samples~/SampleGame/Assets/Prefabs/InputField.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/InputField.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/InputField.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/InputField.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/InputField.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab b/Samples~/SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab rename to Samples~/SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/QuitCanvasStatic.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/SignInScreen.prefab b/Samples~/SampleGame/Assets/Prefabs/SignInScreen.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SignInScreen.prefab rename to Samples~/SampleGame/Assets/Prefabs/SignInScreen.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/SignInScreen.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/SignInScreen.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SignInScreen.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/SignInScreen.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/SignUpScreen.prefab b/Samples~/SampleGame/Assets/Prefabs/SignUpScreen.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SignUpScreen.prefab rename to Samples~/SampleGame/Assets/Prefabs/SignUpScreen.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/SignUpScreen.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/SignUpScreen.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SignUpScreen.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/SignUpScreen.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/Spinner.prefab b/Samples~/SampleGame/Assets/Prefabs/Spinner.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/Spinner.prefab rename to Samples~/SampleGame/Assets/Prefabs/Spinner.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/Spinner.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/Spinner.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/Spinner.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/Spinner.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/StartGameScreen.prefab b/Samples~/SampleGame/Assets/Prefabs/StartGameScreen.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/StartGameScreen.prefab rename to Samples~/SampleGame/Assets/Prefabs/StartGameScreen.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/StartGameScreen.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/StartGameScreen.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/StartGameScreen.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/StartGameScreen.prefab.meta diff --git a/GameLift-SampleGame/Assets/Prefabs/SubmitButton.prefab b/Samples~/SampleGame/Assets/Prefabs/SubmitButton.prefab similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SubmitButton.prefab rename to Samples~/SampleGame/Assets/Prefabs/SubmitButton.prefab diff --git a/GameLift-SampleGame/Assets/Prefabs/SubmitButton.prefab.meta b/Samples~/SampleGame/Assets/Prefabs/SubmitButton.prefab.meta similarity index 100% rename from GameLift-SampleGame/Assets/Prefabs/SubmitButton.prefab.meta rename to Samples~/SampleGame/Assets/Prefabs/SubmitButton.prefab.meta diff --git a/GameLift-SampleGame/Assets/Resources.meta b/Samples~/SampleGame/Assets/Resources.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources.meta rename to Samples~/SampleGame/Assets/Resources.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials.meta b/Samples~/SampleGame/Assets/Resources/Materials.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials.meta rename to Samples~/SampleGame/Assets/Resources/Materials.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color001.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color001.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color001.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color001.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color001.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color001.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color001.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color001.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color002.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color002.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color002.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color002.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color002.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color002.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color002.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color002.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color003.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color003.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color003.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color003.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color003.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color003.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color003.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color003.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color004.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color004.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color004.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color004.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color004.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color004.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color004.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color004.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color005.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color005.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color005.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color005.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color005.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color005.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color005.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color005.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color006.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color006.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color006.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color006.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color006.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color006.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color006.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color006.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color007.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color007.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color007.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color007.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color007.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color007.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color007.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color007.mat.meta diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color008.mat b/Samples~/SampleGame/Assets/Resources/Materials/Color008.mat similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color008.mat rename to Samples~/SampleGame/Assets/Resources/Materials/Color008.mat diff --git a/GameLift-SampleGame/Assets/Resources/Materials/Color008.mat.meta b/Samples~/SampleGame/Assets/Resources/Materials/Color008.mat.meta similarity index 100% rename from GameLift-SampleGame/Assets/Resources/Materials/Color008.mat.meta rename to Samples~/SampleGame/Assets/Resources/Materials/Color008.mat.meta diff --git a/GameLift-SampleGame/Assets/Scenes.meta b/Samples~/SampleGame/Assets/Scenes.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scenes.meta rename to Samples~/SampleGame/Assets/Scenes.meta diff --git a/GameLift-SampleGame/Assets/Scenes/BootstrapScene.unity b/Samples~/SampleGame/Assets/Scenes/BootstrapScene.unity similarity index 100% rename from GameLift-SampleGame/Assets/Scenes/BootstrapScene.unity rename to Samples~/SampleGame/Assets/Scenes/BootstrapScene.unity diff --git a/GameLift-SampleGame/Assets/Scenes/BootstrapScene.unity.meta b/Samples~/SampleGame/Assets/Scenes/BootstrapScene.unity.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scenes/BootstrapScene.unity.meta rename to Samples~/SampleGame/Assets/Scenes/BootstrapScene.unity.meta diff --git a/GameLift-SampleGame/Assets/Scenes/GameScene.unity b/Samples~/SampleGame/Assets/Scenes/GameScene.unity similarity index 100% rename from GameLift-SampleGame/Assets/Scenes/GameScene.unity rename to Samples~/SampleGame/Assets/Scenes/GameScene.unity diff --git a/GameLift-SampleGame/Assets/Scenes/GameScene.unity.meta b/Samples~/SampleGame/Assets/Scenes/GameScene.unity.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scenes/GameScene.unity.meta rename to Samples~/SampleGame/Assets/Scenes/GameScene.unity.meta diff --git a/GameLift-SampleGame/Assets/Scripts.meta b/Samples~/SampleGame/Assets/Scripts.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts.meta rename to Samples~/SampleGame/Assets/Scripts.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Chord.cs b/Samples~/SampleGame/Assets/Scripts/Chord.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Chord.cs rename to Samples~/SampleGame/Assets/Scripts/Chord.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Chord.cs.meta b/Samples~/SampleGame/Assets/Scripts/Chord.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Chord.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Chord.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client.meta b/Samples~/SampleGame/Assets/Scripts/Client.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client.meta rename to Samples~/SampleGame/Assets/Scripts/Client.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client/ClientCredentials.cs b/Samples~/SampleGame/Assets/Scripts/Client/ClientCredentials.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/ClientCredentials.cs rename to Samples~/SampleGame/Assets/Scripts/Client/ClientCredentials.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Client/ClientCredentials.cs.meta b/Samples~/SampleGame/Assets/Scripts/Client/ClientCredentials.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/ClientCredentials.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Client/ClientCredentials.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client/Delay.cs b/Samples~/SampleGame/Assets/Scripts/Client/Delay.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/Delay.cs rename to Samples~/SampleGame/Assets/Scripts/Client/Delay.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Client/Delay.cs.meta b/Samples~/SampleGame/Assets/Scripts/Client/Delay.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/Delay.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Client/Delay.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client/GameLiftClient.cs b/Samples~/SampleGame/Assets/Scripts/Client/GameLiftClient.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/GameLiftClient.cs rename to Samples~/SampleGame/Assets/Scripts/Client/GameLiftClient.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Client/GameLiftClient.cs.meta b/Samples~/SampleGame/Assets/Scripts/Client/GameLiftClient.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/GameLiftClient.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Client/GameLiftClient.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs b/Samples~/SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs rename to Samples~/SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs.meta b/Samples~/SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Client/LoggingGameLiftCoreApi.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Client/NetworkClient.cs b/Samples~/SampleGame/Assets/Scripts/Client/NetworkClient.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/NetworkClient.cs rename to Samples~/SampleGame/Assets/Scripts/Client/NetworkClient.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Client/NetworkClient.cs.meta b/Samples~/SampleGame/Assets/Scripts/Client/NetworkClient.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Client/NetworkClient.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Client/NetworkClient.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/ClientBootstrap.cs b/Samples~/SampleGame/Assets/Scripts/ClientBootstrap.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/ClientBootstrap.cs rename to Samples~/SampleGame/Assets/Scripts/ClientBootstrap.cs diff --git a/GameLift-SampleGame/Assets/Scripts/ClientBootstrap.cs.meta b/Samples~/SampleGame/Assets/Scripts/ClientBootstrap.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/ClientBootstrap.cs.meta rename to Samples~/SampleGame/Assets/Scripts/ClientBootstrap.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/GameLift.cs b/Samples~/SampleGame/Assets/Scripts/GameLift.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLift.cs rename to Samples~/SampleGame/Assets/Scripts/GameLift.cs diff --git a/GameLift-SampleGame/Assets/Scripts/GameLift.cs.meta b/Samples~/SampleGame/Assets/Scripts/GameLift.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLift.cs.meta rename to Samples~/SampleGame/Assets/Scripts/GameLift.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/GameLog.cs b/Samples~/SampleGame/Assets/Scripts/GameLog.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLog.cs rename to Samples~/SampleGame/Assets/Scripts/GameLog.cs diff --git a/GameLift-SampleGame/Assets/Scripts/GameLog.cs.meta b/Samples~/SampleGame/Assets/Scripts/GameLog.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLog.cs.meta rename to Samples~/SampleGame/Assets/Scripts/GameLog.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/GameLogic.cs b/Samples~/SampleGame/Assets/Scripts/GameLogic.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLogic.cs rename to Samples~/SampleGame/Assets/Scripts/GameLogic.cs diff --git a/GameLift-SampleGame/Assets/Scripts/GameLogic.cs.meta b/Samples~/SampleGame/Assets/Scripts/GameLogic.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/GameLogic.cs.meta rename to Samples~/SampleGame/Assets/Scripts/GameLogic.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Global.cs b/Samples~/SampleGame/Assets/Scripts/Global.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Global.cs rename to Samples~/SampleGame/Assets/Scripts/Global.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Global.cs.meta b/Samples~/SampleGame/Assets/Scripts/Global.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Global.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Global.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Input.cs b/Samples~/SampleGame/Assets/Scripts/Input.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Input.cs rename to Samples~/SampleGame/Assets/Scripts/Input.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Input.cs.meta b/Samples~/SampleGame/Assets/Scripts/Input.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Input.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Input.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Logger.cs b/Samples~/SampleGame/Assets/Scripts/Logger.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Logger.cs rename to Samples~/SampleGame/Assets/Scripts/Logger.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Logger.cs.meta b/Samples~/SampleGame/Assets/Scripts/Logger.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Logger.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Logger.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/NetworkProtocol.cs b/Samples~/SampleGame/Assets/Scripts/NetworkProtocol.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/NetworkProtocol.cs rename to Samples~/SampleGame/Assets/Scripts/NetworkProtocol.cs diff --git a/GameLift-SampleGame/Assets/Scripts/NetworkProtocol.cs.meta b/Samples~/SampleGame/Assets/Scripts/NetworkProtocol.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/NetworkProtocol.cs.meta rename to Samples~/SampleGame/Assets/Scripts/NetworkProtocol.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/QuitGame.cs b/Samples~/SampleGame/Assets/Scripts/QuitGame.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/QuitGame.cs rename to Samples~/SampleGame/Assets/Scripts/QuitGame.cs diff --git a/GameLift-SampleGame/Assets/Scripts/QuitGame.cs.meta b/Samples~/SampleGame/Assets/Scripts/QuitGame.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/QuitGame.cs.meta rename to Samples~/SampleGame/Assets/Scripts/QuitGame.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Render.cs b/Samples~/SampleGame/Assets/Scripts/Render.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Render.cs rename to Samples~/SampleGame/Assets/Scripts/Render.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Render.cs.meta b/Samples~/SampleGame/Assets/Scripts/Render.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Render.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Render.cs.meta diff --git a/GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef b/Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef similarity index 63% rename from GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef rename to Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef index 765da6da..6e443164 100644 --- a/GameLift-Unity/Assets/Editor/UiTests/AmazonGameLiftPlugin.Editor.UiTests.asmdef +++ b/Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef @@ -1,12 +1,13 @@ { - "name": "AmazonGameLiftPlugin.Editor.UiTests", + "name": "SampleGame", "references": [ - "AmazonGameLiftPlugin.Editor", - "AmazonGameLiftPlugin.EditorCoreAPI" + "AmazonGameLiftPlugin.Runtime", + "AmazonGameLiftPlugin.Runtime.Core" ], "optionalUnityReferences": [], "includePlatforms": [ - "Editor" + "Editor", + "WindowsStandalone64" ], "excludePlatforms": [], "allowUnsafeCode": false, diff --git a/GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef.meta b/Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/SampleGame.asmdef.meta rename to Samples~/SampleGame/Assets/Scripts/SampleGame.asmdef.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Server.meta b/Samples~/SampleGame/Assets/Scripts/Server.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Server.meta rename to Samples~/SampleGame/Assets/Scripts/Server.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Server/GameLiftServer.cs b/Samples~/SampleGame/Assets/Scripts/Server/GameLiftServer.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Server/GameLiftServer.cs rename to Samples~/SampleGame/Assets/Scripts/Server/GameLiftServer.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Server/GameLiftServer.cs.meta b/Samples~/SampleGame/Assets/Scripts/Server/GameLiftServer.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Server/GameLiftServer.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Server/GameLiftServer.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Server/NetworkServer.cs b/Samples~/SampleGame/Assets/Scripts/Server/NetworkServer.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Server/NetworkServer.cs rename to Samples~/SampleGame/Assets/Scripts/Server/NetworkServer.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Server/NetworkServer.cs.meta b/Samples~/SampleGame/Assets/Scripts/Server/NetworkServer.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Server/NetworkServer.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Server/NetworkServer.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/ServerBootstrap.cs b/Samples~/SampleGame/Assets/Scripts/ServerBootstrap.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/ServerBootstrap.cs rename to Samples~/SampleGame/Assets/Scripts/ServerBootstrap.cs diff --git a/GameLift-SampleGame/Assets/Scripts/ServerBootstrap.cs.meta b/Samples~/SampleGame/Assets/Scripts/ServerBootstrap.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/ServerBootstrap.cs.meta rename to Samples~/SampleGame/Assets/Scripts/ServerBootstrap.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Simulation.cs b/Samples~/SampleGame/Assets/Scripts/Simulation.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Simulation.cs rename to Samples~/SampleGame/Assets/Scripts/Simulation.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Simulation.cs.meta b/Samples~/SampleGame/Assets/Scripts/Simulation.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Simulation.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Simulation.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Status.cs b/Samples~/SampleGame/Assets/Scripts/Status.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Status.cs rename to Samples~/SampleGame/Assets/Scripts/Status.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Status.cs.meta b/Samples~/SampleGame/Assets/Scripts/Status.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Status.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Status.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/Strings.cs b/Samples~/SampleGame/Assets/Scripts/Strings.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Strings.cs rename to Samples~/SampleGame/Assets/Scripts/Strings.cs diff --git a/GameLift-SampleGame/Assets/Scripts/Strings.cs.meta b/Samples~/SampleGame/Assets/Scripts/Strings.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/Strings.cs.meta rename to Samples~/SampleGame/Assets/Scripts/Strings.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI.meta b/Samples~/SampleGame/Assets/Scripts/UI.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI.meta rename to Samples~/SampleGame/Assets/Scripts/UI.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ClientSettingsView.cs b/Samples~/SampleGame/Assets/Scripts/UI/ClientSettingsView.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ClientSettingsView.cs rename to Samples~/SampleGame/Assets/Scripts/UI/ClientSettingsView.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ClientSettingsView.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/ClientSettingsView.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ClientSettingsView.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/ClientSettingsView.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/ConfirmationCodeScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/ConfirmationSuccessScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/FormScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/FormScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/FormScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/FormScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/FormScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/FormScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/FormScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/FormScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/GameScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/GameScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/GameScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/GameScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/GameScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/GameScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/GameScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/GameScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/SignInScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/SignInScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/SignInScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/SignInScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/SignInScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/SignInScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/SignInScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/SignInScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/SignUpScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/SignUpScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/SignUpScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/SignUpScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/SignUpScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/SignUpScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/SignUpScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/SignUpScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Scripts/UI/StartGameScreen.cs b/Samples~/SampleGame/Assets/Scripts/UI/StartGameScreen.cs similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/StartGameScreen.cs rename to Samples~/SampleGame/Assets/Scripts/UI/StartGameScreen.cs diff --git a/GameLift-SampleGame/Assets/Scripts/UI/StartGameScreen.cs.meta b/Samples~/SampleGame/Assets/Scripts/UI/StartGameScreen.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Scripts/UI/StartGameScreen.cs.meta rename to Samples~/SampleGame/Assets/Scripts/UI/StartGameScreen.cs.meta diff --git a/GameLift-SampleGame/Assets/Settings.meta b/Samples~/SampleGame/Assets/Settings.meta similarity index 100% rename from GameLift-SampleGame/Assets/Settings.meta rename to Samples~/SampleGame/Assets/Settings.meta diff --git a/GameLift-SampleGame/Assets/Settings/GameLiftClientSettings.asset b/Samples~/SampleGame/Assets/Settings/GameLiftClientSettings.asset similarity index 100% rename from GameLift-SampleGame/Assets/Settings/GameLiftClientSettings.asset rename to Samples~/SampleGame/Assets/Settings/GameLiftClientSettings.asset diff --git a/GameLift-SampleGame/Assets/Settings/GameLiftClientSettings.asset.meta b/Samples~/SampleGame/Assets/Settings/GameLiftClientSettings.asset.meta similarity index 100% rename from GameLift-SampleGame/Assets/Settings/GameLiftClientSettings.asset.meta rename to Samples~/SampleGame/Assets/Settings/GameLiftClientSettings.asset.meta diff --git a/GameLift-SampleGame/Assets/Sprites.meta b/Samples~/SampleGame/Assets/Sprites.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites.meta rename to Samples~/SampleGame/Assets/Sprites.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI.meta b/Samples~/SampleGame/Assets/Sprites/UI.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI.meta rename to Samples~/SampleGame/Assets/Sprites/UI.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner.meta b/Samples~/SampleGame/Assets/Sprites/UI/Spinner.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner.meta rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png.meta b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png.meta rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 1.png.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png.meta b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png.meta rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 2.png.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png.meta b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png.meta rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 3.png.meta diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png diff --git a/GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png.meta b/Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png.meta similarity index 100% rename from GameLift-SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png.meta rename to Samples~/SampleGame/Assets/Sprites/UI/Spinner/Spinner 4.png.meta diff --git a/GameLift-SampleGame/Assets/Tests.meta b/Samples~/SampleGame/Assets/Tests.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests.meta rename to Samples~/SampleGame/Assets/Tests.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor.meta b/Samples~/SampleGame/Assets/Tests/Editor.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor.meta rename to Samples~/SampleGame/Assets/Tests/Editor.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit.meta b/Samples~/SampleGame/Assets/Tests/Editor/Unit.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit.meta rename to Samples~/SampleGame/Assets/Tests/Editor/Unit.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs b/Samples~/SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs.meta b/Samples~/SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs.meta rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/AssertAsync.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs b/Samples~/SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta b/Samples~/SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs b/Samples~/SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs.meta b/Samples~/SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs.meta rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/GameLiftClientTests.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef b/Samples~/SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef similarity index 72% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef index e97b52e1..e8f409a5 100644 --- a/GameLift-SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef +++ b/Samples~/SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef @@ -2,7 +2,8 @@ "name": "SampleTests.Unit", "references": [ "SampleGame", - "AmazonGameLiftPlugin.Runtime" + "AmazonGameLiftPlugin.Runtime", + "AmazonGameLiftPlugin.Runtime.Core" ], "optionalUnityReferences": [ "TestAssemblies" @@ -12,10 +13,9 @@ ], "excludePlatforms": [], "allowUnsafeCode": false, - "overrideReferences": true, + "overrideReferences": false, "precompiledReferences": [ - "Moq.dll", - "AmazonGameLiftPlugin.Core.dll" + "Moq.dll" ], "autoReferenced": true, "defineConstraints": [] diff --git a/GameLift-SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef.meta b/Samples~/SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef.meta rename to Samples~/SampleGame/Assets/Tests/Editor/Unit/SampleTests.Unit.asmdef.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI.meta b/Samples~/SampleGame/Assets/Tests/UI.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI.meta rename to Samples~/SampleGame/Assets/Tests/UI.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/AssetPaths.cs b/Samples~/SampleGame/Assets/Tests/UI/AssetPaths.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/AssetPaths.cs rename to Samples~/SampleGame/Assets/Tests/UI/AssetPaths.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/AssetPaths.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/AssetPaths.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/AssetPaths.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/AssetPaths.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/AwsTestIdentity.cs b/Samples~/SampleGame/Assets/Tests/UI/AwsTestIdentity.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/AwsTestIdentity.cs rename to Samples~/SampleGame/Assets/Tests/UI/AwsTestIdentity.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/AwsTestIdentity.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/AwsTestIdentity.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/AwsTestIdentity.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/AwsTestIdentity.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs b/Samples~/SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs rename to Samples~/SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/GameLiftClientSettingsOverride.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/GameObjectNames.cs b/Samples~/SampleGame/Assets/Tests/UI/GameObjectNames.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/GameObjectNames.cs rename to Samples~/SampleGame/Assets/Tests/UI/GameObjectNames.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/GameObjectNames.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/GameObjectNames.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/GameObjectNames.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/GameObjectNames.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/PlayModeUtility.cs b/Samples~/SampleGame/Assets/Tests/UI/PlayModeUtility.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/PlayModeUtility.cs rename to Samples~/SampleGame/Assets/Tests/UI/PlayModeUtility.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/PlayModeUtility.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/PlayModeUtility.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/PlayModeUtility.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/PlayModeUtility.cs.meta diff --git a/Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef b/Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef new file mode 100644 index 00000000..6aad1dc4 --- /dev/null +++ b/Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef @@ -0,0 +1,29 @@ +{ + "name": "SampleTests.UI", + "rootNamespace": "", + "references": [ + "SampleGame", + "AmazonGameLiftPlugin.Runtime", + "AmazonGameLiftPlugin.Runtime.Core", + "UnityEngine.TestRunner", + "UnityEditor.TestRunner" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": true, + "precompiledReferences": [ + "Moq.dll", + "nunit.framework.dll", + "AWSSDK.CognitoIdentityProvider.dll", + "AWSSDK.Core.dll", + "Newtonsoft.Json.dll" + ], + "autoReferenced": false, + "defineConstraints": [ + "!UNITY_SERVER", + "UNITY_INCLUDE_TESTS" + ], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef.meta b/Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef.meta rename to Samples~/SampleGame/Assets/Tests/UI/SampleTests.UI.asmdef.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignInTests.cs b/Samples~/SampleGame/Assets/Tests/UI/SignInTests.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignInTests.cs rename to Samples~/SampleGame/Assets/Tests/UI/SignInTests.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignInTests.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/SignInTests.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignInTests.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/SignInTests.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs b/Samples~/SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs rename to Samples~/SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/SignUpTestGameLiftCoreApi.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignUpTests.cs b/Samples~/SampleGame/Assets/Tests/UI/SignUpTests.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignUpTests.cs rename to Samples~/SampleGame/Assets/Tests/UI/SignUpTests.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/SignUpTests.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/SignUpTests.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/SignUpTests.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/SignUpTests.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/StartGameTests.cs b/Samples~/SampleGame/Assets/Tests/UI/StartGameTests.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/StartGameTests.cs rename to Samples~/SampleGame/Assets/Tests/UI/StartGameTests.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/StartGameTests.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/StartGameTests.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/StartGameTests.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/StartGameTests.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestInput.cs b/Samples~/SampleGame/Assets/Tests/UI/TestInput.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestInput.cs rename to Samples~/SampleGame/Assets/Tests/UI/TestInput.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestInput.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/TestInput.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestInput.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/TestInput.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestSettings.cs b/Samples~/SampleGame/Assets/Tests/UI/TestSettings.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestSettings.cs rename to Samples~/SampleGame/Assets/Tests/UI/TestSettings.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestSettings.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/TestSettings.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestSettings.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/TestSettings.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestSettingsSource.cs b/Samples~/SampleGame/Assets/Tests/UI/TestSettingsSource.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestSettingsSource.cs rename to Samples~/SampleGame/Assets/Tests/UI/TestSettingsSource.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/TestSettingsSource.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/TestSettingsSource.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/TestSettingsSource.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/TestSettingsSource.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs b/Samples~/SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs rename to Samples~/SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/WaitForGameObjectFound.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs b/Samples~/SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs rename to Samples~/SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/WaitForSceneLoaded.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs b/Samples~/SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs rename to Samples~/SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/WaitUnitilCondition.cs.meta diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs b/Samples~/SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs rename to Samples~/SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs diff --git a/GameLift-SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs.meta b/Samples~/SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs.meta similarity index 100% rename from GameLift-SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs.meta rename to Samples~/SampleGame/Assets/Tests/UI/WaitWithTimeOut.cs.meta diff --git a/GameLift-Unity/Packages/manifest.json b/Samples~/SampleGame/Packages/manifest.json similarity index 97% rename from GameLift-Unity/Packages/manifest.json rename to Samples~/SampleGame/Packages/manifest.json index 91d6f0ad..7786be0c 100644 --- a/GameLift-Unity/Packages/manifest.json +++ b/Samples~/SampleGame/Packages/manifest.json @@ -1,11 +1,11 @@ { "dependencies": { + "com.amazonaws.gamelift": "file:../../..", "com.unity.2d.sprite": "1.0.0", "com.unity.2d.tilemap": "1.0.0", "com.unity.ide.rider": "2.0.7", "com.unity.ide.visualstudio": "2.0.11", "com.unity.ide.vscode": "1.2.3", - "com.unity.nuget.newtonsoft-json": "2.0.0", "com.unity.test-framework": "1.1.27", "com.unity.timeline": "1.4.8", "com.unity.ugui": "1.0.0", diff --git a/GameLift-SampleGame/README.md b/Samples~/SampleGame/README.md similarity index 100% rename from GameLift-SampleGame/README.md rename to Samples~/SampleGame/README.md diff --git a/GameLift-SampleGame/README.md.meta b/Samples~/SampleGame/README.md.meta similarity index 100% rename from GameLift-SampleGame/README.md.meta rename to Samples~/SampleGame/README.md.meta diff --git a/GameLift-SampleGame/UiTestSettings.json b/Samples~/SampleGame/UiTestSettings.json similarity index 100% rename from GameLift-SampleGame/UiTestSettings.json rename to Samples~/SampleGame/UiTestSettings.json diff --git a/Scripts~/windows/.build-core-library.ps1 b/Scripts~/windows/.build-core-library.ps1 new file mode 100644 index 00000000..0ddeac70 --- /dev/null +++ b/Scripts~/windows/.build-core-library.ps1 @@ -0,0 +1,22 @@ +$ROOT_DIR="." +$RUNTIME_PATH="$ROOT_DIR\Runtime" +$CORE_LIBRARY_PATH="$RUNTIME_PATH\Core" +$CORE_LIBRARY_PLUGINS_PATH="$CORE_LIBRARY_PATH\Plugins" + +echo "Building core library dependencies..." + +if (-Not (Test-Path -Path $RUNTIME_PATH)) +{ + echo "$RUNTIME_PATH is not found in the working directory. Make sure you are executing the script from the project root." + exit 1 +} + +if ((Get-Command "dotnet" -ErrorAction SilentlyContinue) -eq $null) +{ + Write-Host "Unable to find 'dotnet' executable in your PATH. See README on how to install the .NET 4.5 Developer Pack in order to build the Server SDK" + exit 1 +} + +dotnet build "$CORE_LIBRARY_PATH\AmazonGameLiftPlugin.Core.csproj" + +echo "Core library dependencies built and saved in $CORE_LIBRARY_PLUGINS_PATH" diff --git a/Scripts~/windows/.build-gamelift-server-sdk.ps1 b/Scripts~/windows/.build-gamelift-server-sdk.ps1 new file mode 100644 index 00000000..7bdf4f7e --- /dev/null +++ b/Scripts~/windows/.build-gamelift-server-sdk.ps1 @@ -0,0 +1,69 @@ +$ROOT_DIR="." +$RUNTIME_PATH="$ROOT_DIR\Runtime" +$TEMP_PATH="C:\Temp" +$NUGET_EXE_PATH="$TEMP_PATH\nuget.exe" +$TEMP_ZIP_PATH = "$TEMP_PATH\GameLiftServerSDK.zip" +$TEMP_EXTRACTED_PATH = "$TEMP_PATH\GameLiftServerSDK" +$SDK_PATH="$TEMP_EXTRACTED_PATH\GameLift-SDK-Release-4.0.2\GameLift-CSharp-ServerSDK-4.0.2" +$SDK_CSPROJ_PATH="$SDK_PATH\Net45\GameLiftServerSDKNet45.csproj" +$SDK_PACKAGES_CONFIG_PATH="$SDK_PATH\Net45\packages.config" +$RUNTIME_PLUGINS_PATH="$RUNTIME_PATH\Plugins" + +if (-Not (Test-Path -Path $RUNTIME_PATH)) +{ + echo "$RUNTIME_PATH is not found in the working directory. Make sure you are executing the script from the project root." + exit 1 +} + +if ((Get-Command "dotnet" -ErrorAction SilentlyContinue) -eq $null) +{ + Write-Host "Unable to find 'dotnet' executable in your PATH. See README on how to install the .NET 4.5 Developer Pack in order to build the Server SDK" + exit 1 +} + +if (-Not (Test-Path -Path $TEMP_EXTRACTED_PATH) ) +{ + if (-Not (Test-Path -Path $TEMP_ZIP_PATH) ) + { + echo "Downloading GameLift Managed Servers SDK..." + iwr https://gamelift-release.s3-us-west-2.amazonaws.com/GameLift_06_03_2021.zip -OutFile $TEMP_ZIP_PATH + } + else + { + echo "GameLift Server SDK is already downloaded and stored at $TEMP_ZIP_PATH, skip downloading." + } + Expand-Archive -Force -LiteralPath $TEMP_ZIP_PATH -DestinationPath $TEMP_EXTRACTED_PATH + + echo "Updating Newtonsoft.Json version used to 12.0.3 for compatibility with Unity 2020.3" + + (Get-Content $SDK_CSPROJ_PATH).replace('Newtonsoft.Json, Version=9.0.0.0', 'Newtonsoft.Json, Version=12.0.0.0') | Set-Content $SDK_CSPROJ_PATH + (Get-Content $SDK_CSPROJ_PATH).replace('Newtonsoft.Json.9.0.1', 'Newtonsoft.Json.12.0.3') | Set-Content $SDK_CSPROJ_PATH + (Get-Content $SDK_PACKAGES_CONFIG_PATH).replace('id="Newtonsoft.Json" version="9.0.1"', 'id="Newtonsoft.Json" version="12.0.3"') | Set-Content $SDK_PACKAGES_CONFIG_PATH +} +else +{ + echo "GameLIft Server SDK is already downloaded and configured at $TEMP_EXTRACTED_PATH, skipping configuration." +} + +if (-Not (Test-Path -Path $NUGET_EXE_PATH) ) +{ + echo "Downloading NuGet started" + iwr https://dist.nuget.org/win-x86-commandline/latest/nuget.exe -OutFile $NUGET_EXE_PATH + echo "Adding nuget.org source" + C:\Temp\nuget.exe sources Add -Name "nuget.org" -Source https://api.nuget.org/v3/index.json + C:\Temp\nuget.exe sources Enable -Name "nuget.org" +} +else +{ + echo "nuget.exe is already downloaded and stored at NUGET_EXE_PATH, skip downloading." +} + +echo "Building GameLift Server SDK..." +Invoke-Expression '& $NUGET_EXE_PATH restore "$SDK_PATH\GameLiftServerSDKNet45.sln" -PackagesDirectory "$SDK_PATH\packages"' +dotnet build "$SDK_PATH\Net45\GameLiftServerSDKNet45.csproj" --configuration Release --output "$RUNTIME_PLUGINS_PATH" + +# Newtonsoft.json is deleted in favor of the Newtonsoft.json dependency in Unity. See "com.unity.nuget.newtonsoft-json: x.x.x" dependency in package.json. +del "$RUNTIME_PLUGINS_PATH\Newtonsoft.Json.dll" +del "$RUNTIME_PLUGINS_PATH\Newtonsoft.Json.xml" + +echo "GameLift Server SDK build completed!" diff --git a/Scripts~/windows/.build-sample-game.ps1 b/Scripts~/windows/.build-sample-game.ps1 new file mode 100644 index 00000000..808d67ac --- /dev/null +++ b/Scripts~/windows/.build-sample-game.ps1 @@ -0,0 +1,44 @@ +$SAMPLES_PATH=".\Samples~" +$SAMPLE_GAME_PATH="$SAMPLES_PATH\SampleGame" +$SAMPLE_GAME_OUTPUT_PATH="$SAMPLES_PATH\SampleGame.unitypackage" +$SAMPLE_GAME_BUILD_LOG_PATH="$SAMPLES_PATH\SampleGameBuildLog.txt" +$SAMPLE_GAME_EXPORT_TIMEOUT=30 +$EXPORT_START_TIME = Get-Date + +echo "Exporting Sample Game..." + +if (Test-Path -Path $SAMPLE_GAME_OUTPUT_PATH) +{ + del $SAMPLE_GAME_OUTPUT_PATH +} + +if ((Get-Command "Unity.exe" -ErrorAction SilentlyContinue) -eq $null) { + echo "Cannot run Unity.exe. Please add the Unity editor folder (e.g. 'C:\Program Files\Unity\Hub\Editor\\Editor\') to the Windows PATH environment variable." + echo "Export failed" + exit 1 +} + +if (-Not (Test-Path -Path $SAMPLE_GAME_PATH)) +{ + echo "$SAMPLE_GAME_PATH directory is not found in the working directory. Make sure you are executing the script from the project root." + exit 1 +} + +Unity.exe -batchmode -quit -projectPath $SAMPLE_GAME_PATH -logFile $SAMPLE_GAME_BUILD_LOG_PATH -executeMethod UnityPackageExporter.Export + +echo "Unity is exporting the sample game... The final build artifact will be saved in $SAMPLE_GAME_OUTPUT_PATH. Check log in $SAMPLE_GAME_BUILD_LOG_PATH to troubleshoot any issues." + +echo "Waiting for export to complete..." +while ((-not (Test-Path $SAMPLE_GAME_OUTPUT_PATH)) -and $EXPORT_START_TIME.AddSeconds($SAMPLE_GAME_EXPORT_TIMEOUT) -gt (Get-Date)) { + Start-Sleep -m 1000 +} + +if (Test-Path -Path $SAMPLE_GAME_OUTPUT_PATH) +{ + echo "Sample Game export completed! The exported artifact is saved in $SAMPLE_GAME_OUTPUT_PATH" +} +else +{ + echo "Sample Game export failed! Check logs in $SAMPLE_GAME_BUILD_LOG_PATH to troubleshoot any issues." + exit 1 +} diff --git a/Scripts~/windows/.clean-builds.ps1 b/Scripts~/windows/.clean-builds.ps1 new file mode 100644 index 00000000..28b8e5ea --- /dev/null +++ b/Scripts~/windows/.clean-builds.ps1 @@ -0,0 +1,44 @@ +$ROOT_DIR="." +$RUNTIME_PATH="$ROOT_DIR\Runtime" +$CORE_LIBRARY_PLUGINS_PATH="$RUNTIME_PATH\Core\Plugins" +$SERVER_SDK_PLUGINS_PATH="$RUNTIME_PATH\Plugins" +$SAMPLE_GAME_PACKAGE_PATH="Samples~\SampleGame.unitypackage" + +if (-Not (Test-Path -Path $RUNTIME_PATH)) +{ + echo "$RUNTIME_PATH directory is not found in the working directory. Make sure you are executing the script from the project root." + Read-Host -Prompt "Press ENTER to continue" + exit 1 +} + +if (Test-Path -Path $CORE_LIBRARY_PLUGINS_PATH) +{ + echo "Removing all Core Library DLLs" + Get-ChildItem $CORE_LIBRARY_PLUGINS_PATH -Include *.dll -Recurse | Remove-Item +} +else +{ + echo "$CORE_LIBRARY_PLUGINS_PATH not found. Continuing..." +} + +if (Test-Path -Path $SERVER_SDK_PLUGINS_PATH) +{ + echo "Removing all GameLift Server SDK DLLs" + Get-ChildItem $SERVER_SDK_PLUGINS_PATH -Include *.dll -Recurse | Remove-Item +} +else +{ + echo "$SERVER_SDK_PLUGINS_PATH not found. Continuing..." +} + +if (Test-Path -Path $SAMPLE_GAME_PACKAGE_PATH) +{ + echo "Removing packaged sample game" + rm -Recurse -Force $SAMPLE_GAME_PACKAGE_PATH +} +else +{ + echo "$SAMPLE_GAME_PACKAGE_PATH not found. Continuing..." +} + +echo "Builds clean up completed!" diff --git a/Scripts~/windows/.clean-download-files.ps1 b/Scripts~/windows/.clean-download-files.ps1 new file mode 100644 index 00000000..ee2a30ec --- /dev/null +++ b/Scripts~/windows/.clean-download-files.ps1 @@ -0,0 +1,36 @@ +$TEMP_PATH="C:\Temp" +$NUGET_EXE_PATH="$TEMP_PATH\nuget.exe" +$TEMP_ZIP_PATH = "$TEMP_PATH\GameLiftServerSDK.zip" +$TEMP_EXTRACTED_PATH = "$TEMP_PATH\GameLiftServerSDK" + +if (Test-Path -Path $NUGET_EXE_PATH) +{ + echo "Removing $NUGET_EXE_PATH" + rm -Recurse -Force $NUGET_EXE_PATH +} +else +{ + echo "$NUGET_EXE_PATH not found. Continuing..." +} + +if (Test-Path -Path $TEMP_ZIP_PATH) +{ + echo "Removing TEMP_ZIP_PATH" + rm -Recurse -Force $TEMP_ZIP_PATH +} +else +{ + echo "$TEMP_ZIP_PATH not found. Continuing..." +} + +if (Test-Path -Path $TEMP_EXTRACTED_PATH) +{ + echo "Removing TEMP_EXTRACTED_PATH" + rm -Recurse -Force $TEMP_EXTRACTED_PATH +} +else +{ + echo "$TEMP_EXTRACTED_PATH not found. Continuing..." +} + +echo "Download file clean up completed!" diff --git a/Scripts~/windows/.clean-exports.ps1 b/Scripts~/windows/.clean-exports.ps1 new file mode 100644 index 00000000..e470a1c2 --- /dev/null +++ b/Scripts~/windows/.clean-exports.ps1 @@ -0,0 +1,22 @@ +$ROOT_DIR="." +$RUNTIME_PATH="$ROOT_DIR\Runtime" +$BUILD_ARTIFACT_PATH_PATTERN="$ROOT_DIR\com.amazonaws.gamelift-*.tgz" + +if (-Not (Test-Path -Path $RUNTIME_PATH)) +{ + echo "$RUNTIME_PATH directory is not found in the working directory. Make sure you are executing the script from the project root." + Read-Host -Prompt "Press ENTER to continue" + exit 1 +} + +if (Test-Path -Path $BUILD_ARTIFACT_PATH_PATTERN) +{ + echo "Removing build directory and tarball file(s)" + rm -Recurse -Force $BUILD_ARTIFACT_PATH_PATTERN +} +else +{ + echo "$BUILD_ARTIFACT_PATH_PATTERN not found. Continuing..." +} + +echo "Exports clean up completed!" diff --git a/Scripts~/windows/build.ps1 b/Scripts~/windows/build.ps1 new file mode 100644 index 00000000..f6fcc7ef --- /dev/null +++ b/Scripts~/windows/build.ps1 @@ -0,0 +1,3 @@ +& "$PSScriptRoot\.build-core-library.ps1" +& "$PSScriptRoot\.build-gamelift-server-sdk.ps1" +& "$PSScriptRoot\.build-sample-game.ps1" diff --git a/Scripts~/windows/clean.ps1 b/Scripts~/windows/clean.ps1 new file mode 100644 index 00000000..4947009e --- /dev/null +++ b/Scripts~/windows/clean.ps1 @@ -0,0 +1,3 @@ +& "$PSScriptRoot\.clean-builds.ps1" +& "$PSScriptRoot\.clean-download-files.ps1" # Comment this out for faster builds +& "$PSScriptRoot\.clean-exports.ps1" diff --git a/Scripts~/windows/export.ps1 b/Scripts~/windows/export.ps1 new file mode 100644 index 00000000..149c0e92 --- /dev/null +++ b/Scripts~/windows/export.ps1 @@ -0,0 +1,18 @@ +$ROOT_DIR='.' +$RUNTIME_PATH="$ROOT_DIR\Runtime" +$DESTINATION_PATH="$ROOT_DIR\.build" + +if (-Not (Test-Path -Path $RUNTIME_PATH)) +{ + echo "$RUNTIME_PATH directory is not found in the working directory. Make sure you are executing the script from the project root." + Read-Host -Prompt "Press ENTER to continue" + exit 1 +} + +if ((Get-Command "npm" -ErrorAction SilentlyContinue) -eq $null) +{ + Write-Host "Unable to find 'npm' executable in your PATH. Please install nodejs first: https://nodejs.org/en/download/" + exit 1 +} + +npm pack diff --git a/Scripts~/windows/release.ps1 b/Scripts~/windows/release.ps1 new file mode 100644 index 00000000..98b457b6 --- /dev/null +++ b/Scripts~/windows/release.ps1 @@ -0,0 +1,3 @@ +& "$PSScriptRoot\clean.ps1" +& "$PSScriptRoot\build.ps1" +& "$PSScriptRoot\export.ps1" diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests.meta b/Tests.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests.meta rename to Tests.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor.meta b/Tests/Editor.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor.meta rename to Tests/Editor.meta diff --git a/Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef b/Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef new file mode 100644 index 00000000..2fbd623d --- /dev/null +++ b/Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef @@ -0,0 +1,25 @@ +{ + "name": "AmazonGameLiftPlugin.Editor.UnitTests", + "rootNamespace": "", + "references": [ + "AmazonGameLiftPlugin.Editor", + "AmazonGameLiftPlugin.EditorCoreAPI", + "UnityEngine.TestRunner", + "UnityEditor.TestRunner" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": true, + "precompiledReferences": [ + "nunit.framework.dll" + ], + "autoReferenced": false, + "defineConstraints": [ + "UNITY_INCLUDE_TESTS" + ], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef.meta b/Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AmazonGameLiftPlugin.Editor.UnitTests.asmdef.meta rename to Tests/Editor/AmazonGameLiftPlugin.Editor.UnitTests.asmdef.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssemblyInfo.cs b/Tests/Editor/AssemblyInfo.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssemblyInfo.cs rename to Tests/Editor/AssemblyInfo.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssemblyInfo.cs.meta b/Tests/Editor/AssemblyInfo.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssemblyInfo.cs.meta rename to Tests/Editor/AssemblyInfo.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssertAsync.cs b/Tests/Editor/AssertAsync.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssertAsync.cs rename to Tests/Editor/AssertAsync.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssertAsync.cs.meta b/Tests/Editor/AssertAsync.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AssertAsync.cs.meta rename to Tests/Editor/AssertAsync.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsCreationTests.cs b/Tests/Editor/AwsCredentialsCreationTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsCreationTests.cs rename to Tests/Editor/AwsCredentialsCreationTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsCreationTests.cs.meta b/Tests/Editor/AwsCredentialsCreationTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsCreationTests.cs.meta rename to Tests/Editor/AwsCredentialsCreationTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsTests.cs b/Tests/Editor/AwsCredentialsTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsTests.cs rename to Tests/Editor/AwsCredentialsTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsTests.cs.meta b/Tests/Editor/AwsCredentialsTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsTests.cs.meta rename to Tests/Editor/AwsCredentialsTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsUpdateTests.cs b/Tests/Editor/AwsCredentialsUpdateTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsUpdateTests.cs rename to Tests/Editor/AwsCredentialsUpdateTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsUpdateTests.cs.meta b/Tests/Editor/AwsCredentialsUpdateTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/AwsCredentialsUpdateTests.cs.meta rename to Tests/Editor/AwsCredentialsUpdateTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap.meta b/Tests/Editor/Bootstrap.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap.meta rename to Tests/Editor/Bootstrap.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapBucketFormatterTests.cs b/Tests/Editor/Bootstrap/BootstrapBucketFormatterTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapBucketFormatterTests.cs rename to Tests/Editor/Bootstrap/BootstrapBucketFormatterTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapBucketFormatterTests.cs.meta b/Tests/Editor/Bootstrap/BootstrapBucketFormatterTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapBucketFormatterTests.cs.meta rename to Tests/Editor/Bootstrap/BootstrapBucketFormatterTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapSettingsTests.cs b/Tests/Editor/Bootstrap/BootstrapSettingsTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapSettingsTests.cs rename to Tests/Editor/Bootstrap/BootstrapSettingsTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapSettingsTests.cs.meta b/Tests/Editor/Bootstrap/BootstrapSettingsTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapSettingsTests.cs.meta rename to Tests/Editor/Bootstrap/BootstrapSettingsTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapUtilityTests.cs b/Tests/Editor/Bootstrap/BootstrapUtilityTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapUtilityTests.cs rename to Tests/Editor/Bootstrap/BootstrapUtilityTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapUtilityTests.cs.meta b/Tests/Editor/Bootstrap/BootstrapUtilityTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BootstrapUtilityTests.cs.meta rename to Tests/Editor/Bootstrap/BootstrapUtilityTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BucketUrlFormatterTests.cs b/Tests/Editor/Bootstrap/BucketUrlFormatterTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BucketUrlFormatterTests.cs rename to Tests/Editor/Bootstrap/BucketUrlFormatterTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BucketUrlFormatterTests.cs.meta b/Tests/Editor/Bootstrap/BucketUrlFormatterTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Bootstrap/BucketUrlFormatterTests.cs.meta rename to Tests/Editor/Bootstrap/BucketUrlFormatterTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoreApiMockExtensions.cs b/Tests/Editor/CoreApiMockExtensions.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoreApiMockExtensions.cs rename to Tests/Editor/CoreApiMockExtensions.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoreApiMockExtensions.cs.meta b/Tests/Editor/CoreApiMockExtensions.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoreApiMockExtensions.cs.meta rename to Tests/Editor/CoreApiMockExtensions.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoroutineTaskExtensions.cs b/Tests/Editor/CoroutineTaskExtensions.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoroutineTaskExtensions.cs rename to Tests/Editor/CoroutineTaskExtensions.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta b/Tests/Editor/CoroutineTaskExtensions.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/CoroutineTaskExtensions.cs.meta rename to Tests/Editor/CoroutineTaskExtensions.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment.meta b/Tests/Editor/Deployment.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment.meta rename to Tests/Editor/Deployment.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeployerTests.cs b/Tests/Editor/Deployment/DeployerTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeployerTests.cs rename to Tests/Editor/Deployment/DeployerTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeployerTests.cs.meta b/Tests/Editor/Deployment/DeployerTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeployerTests.cs.meta rename to Tests/Editor/Deployment/DeployerTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentRequestFactoryTests.cs b/Tests/Editor/Deployment/DeploymentRequestFactoryTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentRequestFactoryTests.cs rename to Tests/Editor/Deployment/DeploymentRequestFactoryTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentRequestFactoryTests.cs.meta b/Tests/Editor/Deployment/DeploymentRequestFactoryTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentRequestFactoryTests.cs.meta rename to Tests/Editor/Deployment/DeploymentRequestFactoryTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentSettingsTests.cs b/Tests/Editor/Deployment/DeploymentSettingsTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentSettingsTests.cs rename to Tests/Editor/Deployment/DeploymentSettingsTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentSettingsTests.cs.meta b/Tests/Editor/Deployment/DeploymentSettingsTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentSettingsTests.cs.meta rename to Tests/Editor/Deployment/DeploymentSettingsTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentWaiterTests.cs b/Tests/Editor/Deployment/DeploymentWaiterTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentWaiterTests.cs rename to Tests/Editor/Deployment/DeploymentWaiterTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentWaiterTests.cs.meta b/Tests/Editor/Deployment/DeploymentWaiterTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/DeploymentWaiterTests.cs.meta rename to Tests/Editor/Deployment/DeploymentWaiterTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/ScenarioParametersUpdaterTests.cs b/Tests/Editor/Deployment/ScenarioParametersUpdaterTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/ScenarioParametersUpdaterTests.cs rename to Tests/Editor/Deployment/ScenarioParametersUpdaterTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/ScenarioParametersUpdaterTests.cs.meta b/Tests/Editor/Deployment/ScenarioParametersUpdaterTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/ScenarioParametersUpdaterTests.cs.meta rename to Tests/Editor/Deployment/ScenarioParametersUpdaterTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/TestedDeployer.cs b/Tests/Editor/Deployment/TestedDeployer.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/TestedDeployer.cs rename to Tests/Editor/Deployment/TestedDeployer.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/TestedDeployer.cs.meta b/Tests/Editor/Deployment/TestedDeployer.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/TestedDeployer.cs.meta rename to Tests/Editor/Deployment/TestedDeployer.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/UntilResponseFailurePollerTests.cs b/Tests/Editor/Deployment/UntilResponseFailurePollerTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/UntilResponseFailurePollerTests.cs rename to Tests/Editor/Deployment/UntilResponseFailurePollerTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/UntilResponseFailurePollerTests.cs.meta b/Tests/Editor/Deployment/UntilResponseFailurePollerTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/Deployment/UntilResponseFailurePollerTests.cs.meta rename to Tests/Editor/Deployment/UntilResponseFailurePollerTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/ImageLoaderTests.cs b/Tests/Editor/ImageLoaderTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/ImageLoaderTests.cs rename to Tests/Editor/ImageLoaderTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/ImageLoaderTests.cs.meta b/Tests/Editor/ImageLoaderTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/ImageLoaderTests.cs.meta rename to Tests/Editor/ImageLoaderTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest.meta b/Tests/Editor/LocalTest.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest.meta rename to Tests/Editor/LocalTest.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest/LocalTestTests.cs b/Tests/Editor/LocalTest/LocalTestTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest/LocalTestTests.cs rename to Tests/Editor/LocalTest/LocalTestTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest/LocalTestTests.cs.meta b/Tests/Editor/LocalTest/LocalTestTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/LocalTest/LocalTestTests.cs.meta rename to Tests/Editor/LocalTest/LocalTestTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/MockLogger.cs b/Tests/Editor/MockLogger.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/MockLogger.cs rename to Tests/Editor/MockLogger.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/MockLogger.cs.meta b/Tests/Editor/MockLogger.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/MockLogger.cs.meta rename to Tests/Editor/MockLogger.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings.meta b/Tests/Editor/PluginSettings.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings.meta rename to Tests/Editor/PluginSettings.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/BootstrapSettingTests.cs b/Tests/Editor/PluginSettings/BootstrapSettingTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/BootstrapSettingTests.cs rename to Tests/Editor/PluginSettings/BootstrapSettingTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/BootstrapSettingTests.cs.meta b/Tests/Editor/PluginSettings/BootstrapSettingTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/BootstrapSettingTests.cs.meta rename to Tests/Editor/PluginSettings/BootstrapSettingTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/CredentialsSettingTests.cs b/Tests/Editor/PluginSettings/CredentialsSettingTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/CredentialsSettingTests.cs rename to Tests/Editor/PluginSettings/CredentialsSettingTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/CredentialsSettingTests.cs.meta b/Tests/Editor/PluginSettings/CredentialsSettingTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/CredentialsSettingTests.cs.meta rename to Tests/Editor/PluginSettings/CredentialsSettingTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/JavaSettingTests.cs b/Tests/Editor/PluginSettings/JavaSettingTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/JavaSettingTests.cs rename to Tests/Editor/PluginSettings/JavaSettingTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/JavaSettingTests.cs.meta b/Tests/Editor/PluginSettings/JavaSettingTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/PluginSettings/JavaSettingTests.cs.meta rename to Tests/Editor/PluginSettings/JavaSettingTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/RegionBootstrapTests.cs b/Tests/Editor/RegionBootstrapTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/RegionBootstrapTests.cs rename to Tests/Editor/RegionBootstrapTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/RegionBootstrapTests.cs.meta b/Tests/Editor/RegionBootstrapTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/RegionBootstrapTests.cs.meta rename to Tests/Editor/RegionBootstrapTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/StatusTests.cs b/Tests/Editor/StatusTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/StatusTests.cs rename to Tests/Editor/StatusTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/StatusTests.cs.meta b/Tests/Editor/StatusTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/StatusTests.cs.meta rename to Tests/Editor/StatusTests.cs.meta diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/TextProviderTests.cs b/Tests/Editor/TextProviderTests.cs similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/TextProviderTests.cs rename to Tests/Editor/TextProviderTests.cs diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/TextProviderTests.cs.meta b/Tests/Editor/TextProviderTests.cs.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/Tests/Editor/Unit/TextProviderTests.cs.meta rename to Tests/Editor/TextProviderTests.cs.meta diff --git a/Tests/Runtime.meta b/Tests/Runtime.meta new file mode 100644 index 00000000..be40c9e7 --- /dev/null +++ b/Tests/Runtime.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 883aab3ce55c4a0488ecf66a6408d8cc +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core.meta b/Tests/Runtime/Core.meta new file mode 100644 index 00000000..9430b5d1 --- /dev/null +++ b/Tests/Runtime/Core.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a1330b8c14488924ebf8abbe14bb3431 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/AccountManagement.meta b/Tests/Runtime/Core/AccountManagement.meta new file mode 100644 index 00000000..a186543b --- /dev/null +++ b/Tests/Runtime/Core/AccountManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 412fba9ac467b5b4991c475449e785a4 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AccountManagement/AccountManagerTests.cs b/Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/AccountManagement/AccountManagerTests.cs rename to Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs diff --git a/Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs.meta b/Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs.meta new file mode 100644 index 00000000..442ada27 --- /dev/null +++ b/Tests/Runtime/Core/AccountManagement/AccountManagerTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 302af9db45b83aa45a88f2e9332f21ba +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/ApiGateWayManagement.meta b/Tests/Runtime/Core/ApiGateWayManagement.meta new file mode 100644 index 00000000..f3677438 --- /dev/null +++ b/Tests/Runtime/Core/ApiGateWayManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 3c384f5a3a78e9d4b83aaee792cfccf9 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/ApiGateWayManagement/ApiGatewayTests.cs b/Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/ApiGateWayManagement/ApiGatewayTests.cs rename to Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs diff --git a/Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs.meta b/Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs.meta new file mode 100644 index 00000000..789f75e1 --- /dev/null +++ b/Tests/Runtime/Core/ApiGateWayManagement/ApiGatewayTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0f61d24146e79ea43ab151666b4366bc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/ApiGateWayManagement/LocalGameAdapterTests.cs b/Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/ApiGateWayManagement/LocalGameAdapterTests.cs rename to Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs diff --git a/Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs.meta b/Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs.meta new file mode 100644 index 00000000..6957dc6a --- /dev/null +++ b/Tests/Runtime/Core/ApiGateWayManagement/LocalGameAdapterTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6378703cab95d114ab21328444d36611 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/BucketManagement.meta b/Tests/Runtime/Core/BucketManagement.meta new file mode 100644 index 00000000..1b8dcb53 --- /dev/null +++ b/Tests/Runtime/Core/BucketManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 91d1b7bcdd7ba394686f9b01a1c6da41 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/BucketManagement/BucketStoreTests.cs b/Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/BucketManagement/BucketStoreTests.cs rename to Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs diff --git a/Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs.meta b/Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs.meta new file mode 100644 index 00000000..f11eb8d5 --- /dev/null +++ b/Tests/Runtime/Core/BucketManagement/BucketStoreTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: be5fce7d08553a04ebd261fd380414b6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/CredentialManagement.meta b/Tests/Runtime/Core/CredentialManagement.meta new file mode 100644 index 00000000..a2f5951a --- /dev/null +++ b/Tests/Runtime/Core/CredentialManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 0d37222ef3f54a14dae23c3a88ee43a1 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/CredentialManagement/CredentialsStoreTests.cs b/Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/CredentialManagement/CredentialsStoreTests.cs rename to Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs diff --git a/Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs.meta b/Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs.meta new file mode 100644 index 00000000..96909c38 --- /dev/null +++ b/Tests/Runtime/Core/CredentialManagement/CredentialsStoreTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f77acc4fb5961aa4b8af7fd2dddb5173 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/DeploymentManagement.meta b/Tests/Runtime/Core/DeploymentManagement.meta new file mode 100644 index 00000000..53119475 --- /dev/null +++ b/Tests/Runtime/Core/DeploymentManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 33562df94ac5b3f4ab136338a116eba8 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/DeploymentManagement/DeploymentManagerTests.cs b/Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/DeploymentManagement/DeploymentManagerTests.cs rename to Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs diff --git a/Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs.meta b/Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs.meta new file mode 100644 index 00000000..6f65d06e --- /dev/null +++ b/Tests/Runtime/Core/DeploymentManagement/DeploymentManagerTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6c832dbc8ee007044b0db87ef49b83a1 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/Factories.meta b/Tests/Runtime/Core/Factories.meta new file mode 100644 index 00000000..6255014f --- /dev/null +++ b/Tests/Runtime/Core/Factories.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 3705e8eb580774d4c9f8737cca32e9cf +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/BucketStoreFactory.cs b/Tests/Runtime/Core/Factories/BucketStoreFactory.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/BucketStoreFactory.cs rename to Tests/Runtime/Core/Factories/BucketStoreFactory.cs diff --git a/Tests/Runtime/Core/Factories/BucketStoreFactory.cs.meta b/Tests/Runtime/Core/Factories/BucketStoreFactory.cs.meta new file mode 100644 index 00000000..bdbc1de2 --- /dev/null +++ b/Tests/Runtime/Core/Factories/BucketStoreFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f4c9f3bb572548a4da292cca653a87cc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/CredentialsStoreFactory.cs b/Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/CredentialsStoreFactory.cs rename to Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs diff --git a/Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs.meta b/Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs.meta new file mode 100644 index 00000000..9599b159 --- /dev/null +++ b/Tests/Runtime/Core/Factories/CredentialsStoreFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 28213d931ade9b34498fcfa623ed66ad +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/SettingsStoreFactory.cs b/Tests/Runtime/Core/Factories/SettingsStoreFactory.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Factories/SettingsStoreFactory.cs rename to Tests/Runtime/Core/Factories/SettingsStoreFactory.cs diff --git a/Tests/Runtime/Core/Factories/SettingsStoreFactory.cs.meta b/Tests/Runtime/Core/Factories/SettingsStoreFactory.cs.meta new file mode 100644 index 00000000..aaf3e361 --- /dev/null +++ b/Tests/Runtime/Core/Factories/SettingsStoreFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e655c15ddd7da924cbdc5aebe2cdecfe +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/GameLiftLocalTesting.meta b/Tests/Runtime/Core/GameLiftLocalTesting.meta new file mode 100644 index 00000000..ad470498 --- /dev/null +++ b/Tests/Runtime/Core/GameLiftLocalTesting.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 18f1acbb2ce8c1f4a8cead79f7751489 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/GameLiftLocalTesting/GameLiftProcessTests.cs b/Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/GameLiftLocalTesting/GameLiftProcessTests.cs rename to Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs diff --git a/Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs.meta b/Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs.meta new file mode 100644 index 00000000..b996fdbf --- /dev/null +++ b/Tests/Runtime/Core/GameLiftLocalTesting/GameLiftProcessTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 206b00ebce9bc0c419d88b3b86fbd660 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/InstalledJavaVersionCheck.meta b/Tests/Runtime/Core/InstalledJavaVersionCheck.meta new file mode 100644 index 00000000..38254d2d --- /dev/null +++ b/Tests/Runtime/Core/InstalledJavaVersionCheck.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 57613ed61b657e54eabe0fddbc2485e7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs rename to Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs diff --git a/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs.meta b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs.meta new file mode 100644 index 00000000..533f11c0 --- /dev/null +++ b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a86992371592fe24486772df00adc5e9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs rename to Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs diff --git a/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs.meta b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs.meta new file mode 100644 index 00000000..672d4391 --- /dev/null +++ b/Tests/Runtime/Core/InstalledJavaVersionCheck/InstalledJavaVersionProviderTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f84ad28537c68bf4cad7923795240310 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/Latency.meta b/Tests/Runtime/Core/Latency.meta new file mode 100644 index 00000000..a15e93c4 --- /dev/null +++ b/Tests/Runtime/Core/Latency.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 4ca89c6d146f8e5459d85f285967adf6 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Latency/LatencyServiceTests.cs b/Tests/Runtime/Core/Latency/LatencyServiceTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Latency/LatencyServiceTests.cs rename to Tests/Runtime/Core/Latency/LatencyServiceTests.cs diff --git a/Tests/Runtime/Core/Latency/LatencyServiceTests.cs.meta b/Tests/Runtime/Core/Latency/LatencyServiceTests.cs.meta new file mode 100644 index 00000000..de3827c3 --- /dev/null +++ b/Tests/Runtime/Core/Latency/LatencyServiceTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8b780035d76b2844bbb49558f25df8a2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/Properties.meta b/Tests/Runtime/Core/Properties.meta new file mode 100644 index 00000000..9a8bc63f --- /dev/null +++ b/Tests/Runtime/Core/Properties.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 045c62e67c5271f43abadb636c4fcec7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Properties/AssemblyInfo.cs b/Tests/Runtime/Core/Properties/AssemblyInfo.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/Properties/AssemblyInfo.cs rename to Tests/Runtime/Core/Properties/AssemblyInfo.cs diff --git a/Tests/Runtime/Core/Properties/AssemblyInfo.cs.meta b/Tests/Runtime/Core/Properties/AssemblyInfo.cs.meta new file mode 100644 index 00000000..24e1936f --- /dev/null +++ b/Tests/Runtime/Core/Properties/AssemblyInfo.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b370db85074c8174e85d313dedd6abd7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/SettingsManagement.meta b/Tests/Runtime/Core/SettingsManagement.meta new file mode 100644 index 00000000..1e18f0df --- /dev/null +++ b/Tests/Runtime/Core/SettingsManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: bab8516d0aa27e04c8dbdf9c778d1def +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/SettingsManagement/SettingsStoreTests.cs b/Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/SettingsManagement/SettingsStoreTests.cs rename to Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs diff --git a/Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs.meta b/Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs.meta new file mode 100644 index 00000000..e80a64b6 --- /dev/null +++ b/Tests/Runtime/Core/SettingsManagement/SettingsStoreTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 943a538496afda94ebc83a5519197fe5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Tests/Runtime/Core/UserIdentityManagement.meta b/Tests/Runtime/Core/UserIdentityManagement.meta new file mode 100644 index 00000000..ed0be3d8 --- /dev/null +++ b/Tests/Runtime/Core/UserIdentityManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: d75c62ebc2409dc4caecc5bd8a88e849 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/UserIdentityManagement/UserIdentityTests.cs b/Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs similarity index 100% rename from AmazonGameLiftPlugin.Core/AmazonGameLiftPlugin.Core.Tests/UserIdentityManagement/UserIdentityTests.cs rename to Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs diff --git a/Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs.meta b/Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs.meta new file mode 100644 index 00000000..b6500d86 --- /dev/null +++ b/Tests/Runtime/Core/UserIdentityManagement/UserIdentityTests.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4d499d8cdff8b8c4caad199542e0c613 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/bin/windows/build.ps1 b/bin/windows/build.ps1 deleted file mode 100644 index 4e1e42c5..00000000 --- a/bin/windows/build.ps1 +++ /dev/null @@ -1,27 +0,0 @@ -$ROOT_DIR='.' -$UNITY_PROJECT_PATH=Join-Path $ROOT_DIR 'GameLift-Unity' - -if (-Not (Test-Path -Path $UNITY_PROJECT_PATH)) -{ - echo "'GameLift-Unity' directory is not found in the working directory. Make sure you are executing the script from the project root." - Read-Host -Prompt "Press ENTER to continue" - exit 1 -} - -$BUILD_PATH=Join-Path $ROOT_DIR 'build' -$LOG_PATH=Join-Path $BUILD_PATH 'build_log.txt' -$BUILD_ARTIFACT_PATH_PATTERN=Join-Path $BUILD_PATH 'com.amazonaws.gamelift-*.tar' -$BUILD_START_TIME = Get-Date - -echo "“Building Amazon GameLift Plug-in for Unity artifacts into a tarball file" -Unity.exe -batchmode -quit -projectPath $UNITY_PROJECT_PATH -logFile $LOG_PATH -executeMethod AWS.GameLift.Editor.PluginPacker.Pack - -echo . -echo "Unity is building the plugin... The final build artifact will be saved in $BUILD_PATH. Check log in $LOG_PATH to troubleshoot any issues." - -echo "Waiting for build to complete..." -while ((-not (Test-Path $BUILD_ARTIFACT_PATH_PATTERN)) -and $BUILD_START_TIME.AddSeconds(30) -gt (Get-Date)) { - Start-Sleep -m 1000 -} - -Read-Host -Prompt "Press ENTER to continue" \ No newline at end of file diff --git a/bin/windows/clean.ps1 b/bin/windows/clean.ps1 deleted file mode 100644 index 8f9d3114..00000000 --- a/bin/windows/clean.ps1 +++ /dev/null @@ -1,56 +0,0 @@ -$ROOT_DIR="." -$CORE_LIB_PACKAGE_PATH=Join-Path $ROOT_DIR "AmazonGameLiftPlugin.Core\packages" -$UNITY_PROJECT_PATH=Join-Path $ROOT_DIR 'GameLift-Unity' -$RUNTIME_PLUGINS_PATH=Join-Path $UNITY_PROJECT_PATH "Assets\com.amazonaws.gamelift\Runtime\Plugins" -$EXAMPLE_PATH=Join-Path $ROOT_DIR "GameLift-Unity\Assets\com.amazonaws.gamelift\Examples~" -$BUILD_PATH=Join-Path $ROOT_DIR "build" - -if (-Not (Test-Path -Path $UNITY_PROJECT_PATH)) -{ - echo "'GameLift-Unity' directory is not found in the working directory. Make sure you are executing the script from the project root." - Read-Host -Prompt "Press ENTER to continue" - exit 1 -} - -if (Test-Path -Path $CORE_LIB_PACKAGE_PATH) -{ - echo "Removing all resolved NuGet dependencies for the Core Library" - rm -Recurse -Force $CORE_LIB_PACKAGE_PATH -} -else -{ - echo "$CORE_LIB_PACKAGE_PATH not found. Continuing..." -} - -if (Test-Path -Path $RUNTIME_PLUGINS_PATH) -{ - echo "Removing all DLLs from the Core Library and GameLift Server SDK" - Get-ChildItem $RUNTIME_PLUGINS_PATH -Include *.dll -Recurse | Remove-Item -} -else -{ - echo "$RUNTIME_PLUGINS_PATH not found. Continuing..." -} - -if (Test-Path -Path $EXAMPLE_PATH) -{ - echo "Removing example game and custom scenario template" - rm -Recurse -Force $EXAMPLE_PATH -} -else -{ - echo "$EXAMPLE_PATH not found. Continuing..." -} - -if (Test-Path -Path $BUILD_PATH) -{ - echo "Removing build directory and tarball file(s)" - rm -Recurse -Force $BUILD_PATH -} -else -{ - echo "$BUILD_PATH not found. Continuing..." -} - -echo "Clean up completed!" -Read-Host -Prompt "Press ENTER to continue" \ No newline at end of file diff --git a/bin/windows/setup.ps1 b/bin/windows/setup.ps1 deleted file mode 100644 index dd308645..00000000 --- a/bin/windows/setup.ps1 +++ /dev/null @@ -1,79 +0,0 @@ -$ROOT_DIR='.' -$UNITY_PROJECT_PATH=Join-Path $ROOT_DIR 'GameLift-Unity' - -if (-Not (Test-Path -Path $UNITY_PROJECT_PATH)) -{ - echo "'GameLift-Unity' directory is not found in the working directory. Make sure you are executing the script from the project root." - Read-Host -Prompt "Press ENTER to continue" - exit 1 -} - -# 'dotnet' command is included with the .NET SDK https://docs.microsoft.com/en-us/dotnet/core/sdk -# You need to install the .NET 4.5 Developer Pack to build the Server SDK. -$RUNTIME_PLUGINS_PATH="GameLift-Unity\Assets\com.amazonaws.gamelift\Runtime\Plugins" -$TESTS_PLUGINS_PATH="GameLift-Unity\Assets\com.amazonaws.gamelift\Tests\Plugins" - -echo . -echo "Downloading NuGet started" -iwr https://dist.nuget.org/win-x86-commandline/latest/nuget.exe -OutFile "nuget.exe" -echo "Adding nuget.org source" -.\nuget sources Add -Name "nuget.org" -Source https://api.nuget.org/v3/index.json -.\nuget sources Enable -Name "nuget.org" - -echo . -echo "Restoring Moq started" -mkdir -p "tmp_packages" -if ( Test-Path -Path "tmp_packages" -PathType Container ) { rm -Recurse -Force "tmp_packages" } -.\nuget.exe install Moq -Version "4.16.1" -Framework "net45" -OutputDirectory "tmp_packages" -.\nuget.exe install Castle.Core -Version "4.4.0" -Framework "net45" -OutputDirectory "tmp_packages" -gci "tmp_packages\Castle.Core.4.4.0\lib\net45" | move -Force -Destination $TESTS_PLUGINS_PATH -gci "tmp_packages\Moq.4.16.1\lib\net45" | move -Force -Destination $TESTS_PLUGINS_PATH -gci "tmp_packages\System.Runtime.CompilerServices.Unsafe.4.5.3\lib\net461" | move -Force -Destination $TESTS_PLUGINS_PATH -gci "tmp_packages\System.Threading.Tasks.Extensions.4.5.4\lib\net461" | move -Force -Destination $TESTS_PLUGINS_PATH -rm -Recurse -Force "tmp_packages" - -echo . -echo "AmazonGameLiftPlugin.Core build started" -$CORE_PATH="AmazonGameLiftPlugin.Core" -.\nuget.exe restore "$CORE_PATH\AmazonGameLiftPlugin.Core.sln" -PackagesDirectory "$CORE_PATH\packages" -dotnet build "$CORE_PATH\AmazonGameLiftPlugin.Core\AmazonGameLiftPlugin.Core.csproj" --configuration Release --output $RUNTIME_PLUGINS_PATH -del "$RUNTIME_PLUGINS_PATH\Newtonsoft.Json.dll" -del "$RUNTIME_PLUGINS_PATH\Newtonsoft.Json.xml" - -echo . -echo "Downloading GameLift Managed Servers SDK..." -$SDK_ZIP_PATH = "C:\Temp\GameLiftServerSDK.zip" -$SDK_TMP_PATH = "C:\Temp\GameLiftServerSDK" -iwr https://gamelift-release.s3-us-west-2.amazonaws.com/GameLift_06_03_2021.zip -OutFile $SDK_ZIP_PATH -Expand-Archive -Force -LiteralPath $SDK_ZIP_PATH -DestinationPath $SDK_TMP_PATH -del $SDK_ZIP_PATH -$SDK_PATH="$SDK_TMP_PATH\GameLift-SDK-Release-4.0.2\GameLift-CSharp-ServerSDK-4.0.2" - -echo . -echo "Updating Newtonsoft.Json version used to 12.0.3 for compatibility with Unity 2020.3" -$SDK_CSPROJ_PATH="$SDK_PATH\Net45\GameLiftServerSDKNet45.csproj" -$SDK_PKG_CONFIG_PATH="$SDK_PATH\Net45\packages.config" -(Get-Content $SDK_CSPROJ_PATH).replace('Newtonsoft.Json, Version=9.0.0.0', 'Newtonsoft.Json, Version=12.0.0.0') | Set-Content $SDK_CSPROJ_PATH -(Get-Content $SDK_CSPROJ_PATH).replace('Newtonsoft.Json.9.0.1', 'Newtonsoft.Json.12.0.3') | Set-Content $SDK_CSPROJ_PATH -(Get-Content $SDK_PKG_CONFIG_PATH).replace('id="Newtonsoft.Json" version="9.0.1"', 'id="Newtonsoft.Json" version="12.0.3"') | Set-Content $SDK_PKG_CONFIG_PATH - -echo . -echo "GameLiftServerSDK build started" -.\nuget.exe restore "$SDK_PATH\GameLiftServerSDKNet45.sln" -PackagesDirectory "$SDK_PATH\packages" -dotnet build "$SDK_PATH\Net45\GameLiftServerSDKNet45.csproj" --configuration Release --output "$RUNTIME_PLUGINS_PATH\GameLiftServerSDK" -del "$RUNTIME_PLUGINS_PATH\GameLiftServerSDK\Newtonsoft.Json.dll" -del "$RUNTIME_PLUGINS_PATH\GameLiftServerSDK\Newtonsoft.Json.xml" -rm -Recurse -Force $SDK_TMP_PATH -del "nuget.exe" - -if ((Get-Command "Unity.exe" -ErrorAction SilentlyContinue) -eq $null) { - echo "You need to add target Unity editor folder (e.g. 'C:\Program Files\Unity\Hub\Editor\\Editor\') to the Windows PATH environment variable." - echo "Setup failed" - Read-Host -Prompt "Press ENTER to continue" - exit -} - -Unity.exe -batchmode -quit -projectPath "GameLift-SampleGame" -executeMethod UnityPackageExporter.Export -Unity.exe -batchmode -quit -projectPath "GameLift-Unity" -executeMethod AWS.GameLift.Editor.CustomScenarioPackageExporter.Export -echo "Setup complete" -Read-Host -Prompt "Press ENTER to continue" \ No newline at end of file diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/package.json b/package.json similarity index 62% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/package.json rename to package.json index 8f6f88e8..be624ce0 100644 --- a/GameLift-Unity/Assets/com.amazonaws.gamelift/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "com.amazonaws.gamelift", "displayName": "Amazon GameLift Plugin for Unity", "author": "Amazon.com, Inc.", - "version": "1.0.0", + "version": "1.1.0", "unity": "2019.4", "description": "The Amazon GameLift Plugin for Unity contains libraries and native UI that makes it easier to access GameLift resources and integrate GameLift into your Unity game. You can use the GameLift Unity Plugin to access GameLift APIs and deploy AWS CloudFormation templates for common gaming scenarios.", "documentationUrl": "https://docs.aws.amazon.com/gamelift/latest/developerguide/unity-plug-in.html", @@ -10,20 +10,21 @@ "licensesUrl": "https://github.com/aws/amazon-gamelift-plugin-unity/blob/main/LICENSE.md", "keywords": [ "AWS", - "GameLift", - "Multiplayer" + "GameLift", + "Multiplayer" ], "dependencies": { "com.unity.nuget.newtonsoft-json": "2.0.0" }, + "repository": { + "type": "git", + "url": "https://github.com/aws/amazon-gamelift-plugin-unity.git" + }, "samples": [ { - "displayName": "Sample Game", - "path": "Examples~/SampleGame" - }, - { - "displayName": "Custom Scenario", - "path": "Examples~/CustomScenario" + "displayName": "Custom Scenario", + "description": "Base template of a deployment scenario used to create a customized backend service for your own multiplayer game requirements. This is the same as the AuthOnly deployment scenario, except stored in your Unity project's Asset folder for version control.", + "path": "Samples~/CustomScenario" } ] } diff --git a/GameLift-Unity/Assets/com.amazonaws.gamelift/package.json.meta b/package.json.meta similarity index 100% rename from GameLift-Unity/Assets/com.amazonaws.gamelift/package.json.meta rename to package.json.meta From fb997b061de9a3b9b3f4549f7566533ef8c38394 Mon Sep 17 00:00:00 2001 From: James Miao Date: Tue, 28 Sep 2021 14:34:35 -0700 Subject: [PATCH 6/7] Fix SDK Integration Guide URL (#35) Co-authored-by: James Miao --- Editor/Urls.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Editor/Urls.cs b/Editor/Urls.cs index e4c81eca..59730a27 100644 --- a/Editor/Urls.cs +++ b/Editor/Urls.cs @@ -18,7 +18,7 @@ internal static class Urls public const string AwsSecurity = "https://aws.amazon.com/security/vulnerability-reporting/"; public const string GitHubAwsLabs = "https://github.com/awslabs/amazon-gamelift-plugin-unity/issues"; public const string JavaDownload = "https://www.java.com/en/download/"; - public const string GameLiftServerCSharpSdkIntegrationDoc = "https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-engines-setup-unreal.html"; + public const string GameLiftServerCSharpSdkIntegrationDoc = "https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-engines-unity-using.html"; public const string GameLiftServerCSharpSdkApiDoc = "https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk-csharp-ref.html"; } } From 8b485679138a2d1f0d97d2678753eb674323fc53 Mon Sep 17 00:00:00 2001 From: James Miao Date: Fri, 1 Oct 2021 13:30:00 -0700 Subject: [PATCH 7/7] Filter S3 bootstrap bucket by region; Add spinner when filtering ListBuckets results (#37) Co-authored-by: James Miao --- CHANGELOG.md | 2 + Editor/Bootstrap/BootstrapBucketFormatter.cs | 2 +- Editor/Bootstrap/BootstrapSettings.cs | 74 ++++++++++++-------- Editor/Bootstrap/BootstrapWindow.cs | 60 +++++++++++++--- Editor/CoreAPI/CoreApi.cs | 3 +- Editor/Credentials/Strings.cs | 1 + Editor/TextFilter.cs | 8 +++ Editor/TextProvider.cs | 1 + Runtime/Core/BucketManagement/BucketStore.cs | 16 ++++- 9 files changed, 126 insertions(+), 41 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 563127df..1f49192d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ CHANGELOG - Documentation - Update and re-format READMEs - Use the correct URL for deployment scenario help link +- Bug Fix + - Fix bug where bootstrap S3 buckets show all buckets in all regions, add async loading for S3 bucket loading # 1.0.0 (09/17/2021) diff --git a/Editor/Bootstrap/BootstrapBucketFormatter.cs b/Editor/Bootstrap/BootstrapBucketFormatter.cs index 69629557..4fc8a4bf 100644 --- a/Editor/Bootstrap/BootstrapBucketFormatter.cs +++ b/Editor/Bootstrap/BootstrapBucketFormatter.cs @@ -13,7 +13,7 @@ public string FormatBucketName(string accountId, string region) { string key1 = FormatBucketKey(accountId); string key2 = FormatBucketKey(region); - return $"do-not-delete-gamelift-bootstrap-{key1}-{key2}"; + return $"gamelift-bootstrap-{key1}-{key2}"; } /// diff --git a/Editor/Bootstrap/BootstrapSettings.cs b/Editor/Bootstrap/BootstrapSettings.cs index ab36eda3..7820a534 100644 --- a/Editor/Bootstrap/BootstrapSettings.cs +++ b/Editor/Bootstrap/BootstrapSettings.cs @@ -4,6 +4,8 @@ using System; using System.Collections.Generic; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using AmazonGameLiftPlugin.Core.AccountManagement.Models; using AmazonGameLiftPlugin.Core.BucketManagement.Models; using AmazonGameLiftPlugin.Core.SettingsManagement.Models; @@ -97,10 +99,9 @@ public BootstrapSettings(IEnumerable lifecyclePolicies, AllLifecyclePolicyNames = lifecyclePolicyNames.ToArray(); } - public void SetUp() + public async Task SetUp(CancellationToken cancellationToken = default) { - RefreshExistingBuckets(); - SelectedMode = _existingBuckets.Count != 0 ? SelectionMode : CreationMode; + await RefreshExistingBuckets(cancellationToken); } public void SelectBucket(string name) @@ -169,40 +170,57 @@ public void SaveSelectedBucket() ///

/// Sets to true when complete. /// - public void RefreshExistingBuckets() + public async Task RefreshExistingBuckets(CancellationToken cancellationToken = default) { IsBucketListLoaded = false; + _status.IsDisplayed = false; + _existingBuckets.Clear(); - GetSettingResponse profileResponse = _coreApi.GetSetting(SettingsKeys.CurrentProfileName); - - if (!profileResponse.Success) + try { - SetErrorStatus(Strings.StatusGetProfileFailed); - _logger.LogResponseError(profileResponse); - return; - } + GetSettingResponse profileResponse = _coreApi.GetSetting(SettingsKeys.CurrentProfileName); - GetSettingResponse regionResponse = _coreApi.GetSetting(SettingsKeys.CurrentRegion); + if (!profileResponse.Success) + { + SetErrorStatus(Strings.StatusGetProfileFailed); + _logger.LogResponseError(profileResponse); + return; + } - if (!regionResponse.Success || !_coreApi.IsValidRegion(regionResponse.Value)) - { - SetErrorStatus(Strings.StatusGetRegionFailed); - _logger.LogResponseError(regionResponse); - return; - } + GetSettingResponse regionResponse = _coreApi.GetSetting(SettingsKeys.CurrentRegion); - GetBucketsResponse bucketsResponse = _coreApi.ListBuckets(profileResponse.Value, regionResponse.Value); + if (!regionResponse.Success || !_coreApi.IsValidRegion(regionResponse.Value)) + { + SetErrorStatus(Strings.StatusGetRegionFailed); + _logger.LogResponseError(regionResponse); + return; + } + + GetBucketsResponse bucketsResponse = await Task.Run(() => _coreApi.ListBuckets(profileResponse.Value, regionResponse.Value), cancellationToken); - if (!bucketsResponse.Success) + if (!bucketsResponse.Success) + { + SetErrorStatus(Strings.StatusBootstrapFailedTemplate, bucketsResponse); + _logger.LogResponseError(bucketsResponse); + return; + } + + _existingBuckets = bucketsResponse.Buckets.ToList(); + } + catch (TaskCanceledException) { - SetErrorStatus(Strings.StatusBootstrapFailedTemplate, bucketsResponse); - _logger.LogResponseError(bucketsResponse); - return; + throw; + } + catch (Exception ex) + { + _logger.LogException(ex); + throw; + } + finally + { + IsBucketListLoaded = true; + OnBucketsLoaded?.Invoke(_existingBuckets); } - - _existingBuckets = bucketsResponse.Buckets.ToList(); - IsBucketListLoaded = true; - OnBucketsLoaded?.Invoke(_existingBuckets); } public void Refresh() @@ -296,8 +314,6 @@ private void SetStatus(string statusKey, MessageType messageType) private void OnBucketCreated(string profileName, string region, string bucketName) { - RefreshExistingBuckets(); - PutSettingResponse bucketNameResponse = _coreApi.PutSetting(SettingsKeys.CurrentBucketName, bucketName); if (!bucketNameResponse.Success) diff --git a/Editor/Bootstrap/BootstrapWindow.cs b/Editor/Bootstrap/BootstrapWindow.cs index e7caaf94..94e53c2d 100644 --- a/Editor/Bootstrap/BootstrapWindow.cs +++ b/Editor/Bootstrap/BootstrapWindow.cs @@ -2,6 +2,8 @@ // SPDX-License-Identifier: Apache-2.0 using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; using UnityEditor; using UnityEngine; @@ -16,14 +18,17 @@ internal class BootstrapWindow : EditorWindow private const float TopMarginPixels = 15f; private const float LeftMarginPixels = 15f; private const float RightMarginPixels = 13f; + private const float SelectionTextFieldHeight = 20f; private const float SelectionHeightPixels = 110f; private const float LabelWidthPixels = 150f; private const float VerticalSpacingPixels = 5f; + private const float SpinnerSizePixels = 23f; private HyperLinkButton _consoleHyperLinkButton; private TextFilter _bucketsTextFilter; private StatusLabel _statusLabel; private BootstrapSettings _bootstrapSettings; private int _confirmedMode = -1; + private ImageSequenceDrawer _spinnerDrawer; private ControlDrawer _controlDrawer; private TextProvider _textProvider; @@ -38,9 +43,11 @@ internal class BootstrapWindow : EditorWindow private string _tooltipRegion; private string _tooltipCurrentBucket; private string _labelBucketCosts; + private string _labelLoading; private string _policyWarning; private int _cachedPolicy = -1; private bool _needResize; + private CancellationTokenSource _refreshBucketsCancellation; private void SetUp() { @@ -50,11 +57,11 @@ private void SetUp() _bucketsTextFilter = new TextFilter(string.Empty, SelectionHeightPixels); _statusLabel = new StatusLabel(); _controlDrawer = ControlDrawerFactory.Create(); + _spinnerDrawer = SpinnerDrawerFactory.Create(size: SpinnerSizePixels); _consoleHyperLinkButton = new HyperLinkButton(_textProvider.Get(Strings.LabelBootstrapS3Console), Urls.AwsS3Console, ResourceUtility.GetHyperLinkStyle()); _bootstrapSettings.OnBucketsLoaded += OnBucketsLoaded; _bootstrapSettings.Status.Changed += OnStatusChanged; - _bootstrapSettings.SetUp(); _uiModes = new[] { _textProvider.Get(Strings.LabelBootstrapCreateMode), @@ -71,6 +78,16 @@ private void SetUp() _tooltipCurrentBucket = _textProvider.Get(Strings.TooltipBootstrapCurrentBucket); _labelBucketCosts = _textProvider.Get(Strings.LabelBootstrapBucketCosts); _policyWarning = _textProvider.Get(Strings.LabelBootstrapLifecycleWarning); + _labelLoading = _textProvider.Get(Strings.LabelBootstrapBucketSelectionLoading); + + _refreshBucketsCancellation = new CancellationTokenSource(); + _bootstrapSettings.SetUp(_refreshBucketsCancellation.Token) + .ContinueWith(task => + { + _confirmedMode = _bootstrapSettings.SelectedMode; + _bootstrapSettings.RefreshCurrentBucket(); + UpdateWindowSize(); + }, TaskContinuationOptions.ExecuteSynchronously); } private void OnEnable() @@ -80,6 +97,7 @@ private void OnEnable() private void OnDisable() { + _refreshBucketsCancellation?.Cancel(); _bootstrapSettings.Status.Changed -= OnStatusChanged; _bootstrapSettings.OnBucketsLoaded -= OnBucketsLoaded; } @@ -101,6 +119,22 @@ private void OnGUI() GUILayout.Space(RightMarginPixels); } } + private void OnInspectorUpdate() + { + if (_bootstrapSettings.IsBucketListLoaded) + { + _spinnerDrawer.Stop(); + } + else + { + _spinnerDrawer.Start(); + } + + if (_spinnerDrawer.IsRunning) + { + Repaint(); + } + } private void DrawControls() { @@ -143,17 +177,17 @@ private void SetUpForSelectedMode() } _confirmedMode = _bootstrapSettings.SelectedMode; - _bucketsTextFilter.CurrentText = string.Empty; - _bootstrapSettings.SelectBucket(string.Empty); _bootstrapSettings.RefreshCurrentBucket(); if (_bootstrapSettings.SelectedMode == BootstrapSettings.CreationMode) { + _refreshBucketsCancellation?.Cancel(); _bootstrapSettings.RefreshBucketName(); } else { - _bootstrapSettings.RefreshExistingBuckets(); + _refreshBucketsCancellation = new CancellationTokenSource(); + _ = _bootstrapSettings.RefreshExistingBuckets(_refreshBucketsCancellation.Token); } GUI.FocusControl(null); @@ -200,8 +234,7 @@ private void DrawSelectButton() private void DrawModeSelection() { - _bootstrapSettings.SelectedMode = GUILayout.SelectionGrid( -_bootstrapSettings.SelectedMode, _uiModes, 1, EditorStyles.radioButton); + _bootstrapSettings.SelectedMode = GUILayout.SelectionGrid(_bootstrapSettings.SelectedMode, _uiModes, 1, EditorStyles.radioButton); } private void DrawBucketCreation() @@ -240,11 +273,21 @@ private void DrawBucketSelection() { EditorGUILayout.PrefixLabel(_labelBootstrapBucketName); - using (new EditorGUILayout.HorizontalScope()) + if (!_bootstrapSettings.IsBucketListLoaded) + { + + using (new EditorGUILayout.HorizontalScope(GUILayout.Height(SelectionHeightPixels + SelectionTextFieldHeight))) + { + GUILayout.Label(_labelLoading); + _spinnerDrawer.Draw(); + } + } + else { _bucketsTextFilter.Draw(); - _bootstrapSettings.SelectBucket(_bucketsTextFilter.ConfirmedOption); } + + _bootstrapSettings.SelectBucket(_bucketsTextFilter.ConfirmedOption); } private void DrawStatus() @@ -287,6 +330,7 @@ private void SetWindowSize(float height) private void OnBucketsLoaded(IReadOnlyList buckets) { _bucketsTextFilter.SetOptions(buckets); + Repaint(); } private void OnStatusChanged() diff --git a/Editor/CoreAPI/CoreApi.cs b/Editor/CoreAPI/CoreApi.cs index 8863ae3d..b1aac768 100644 --- a/Editor/CoreAPI/CoreApi.cs +++ b/Editor/CoreAPI/CoreApi.cs @@ -225,8 +225,7 @@ public virtual GetBucketsResponse ListBuckets(string profileName, string region) var bucketStore = new BucketStore(CreateS3Wrapper(profileName, region)); var request = new GetBucketsRequest() { - // TODO: restore if the filter is fixed - // Region = region + Region = region }; return bucketStore.GetBuckets(request); } diff --git a/Editor/Credentials/Strings.cs b/Editor/Credentials/Strings.cs index 23e6a3b6..a72acc04 100644 --- a/Editor/Credentials/Strings.cs +++ b/Editor/Credentials/Strings.cs @@ -19,6 +19,7 @@ public static class Strings public const string LabelBootstrapBucketCosts = "LabelBootstrapBucketCosts"; public const string LabelBootstrapBucketName = "LabelBootstrapBucketName"; public const string LabelBootstrapLifecycleWarning = "LabelBootstrapLifecycleWarning"; + public const string LabelBootstrapBucketSelectionLoading = "LabelBootstrapBucketSelectionLoading"; public const string LabelBootstrapRegion = "LabelBootstrapRegion"; public const string LabelBootstrapBucketLifecycle = "LabelBootstrapBucketLifecycle"; public const string LabelCredentialsHelp = "LabelCredentialsHelp"; diff --git a/Editor/TextFilter.cs b/Editor/TextFilter.cs index 6fa645f9..f72ca1d1 100644 --- a/Editor/TextFilter.cs +++ b/Editor/TextFilter.cs @@ -26,6 +26,7 @@ public sealed class TextFilter private GUIStyle _normalStyle; private GUIStyle _selectedStyle; private Vector2 _scrollPosition; + private Boolean _areOptionsUpdated = false; public string CurrentText { @@ -56,6 +57,7 @@ public void SetOptions(IReadOnlyList value) _options = value.ToList(); _currentText = value.Count == 0 ? _defaultText : string.Empty; + _areOptionsUpdated = true; } public void Draw() @@ -69,6 +71,12 @@ public void Draw() { _currentText = EditorGUILayout.TextField(_currentText); + if (_areOptionsUpdated) + { + _filteredOptions = _options.ToArray(); + _areOptionsUpdated = false; + } + if (_currentText != _confirmedText) { _confirmedText = _currentText; diff --git a/Editor/TextProvider.cs b/Editor/TextProvider.cs index 0ad11438..2cc68123 100644 --- a/Editor/TextProvider.cs +++ b/Editor/TextProvider.cs @@ -60,6 +60,7 @@ internal sealed class TextProvider { Strings.LabelBootstrapCreateMode, "Create a new S3 bucket"}, { Strings.LabelBootstrapBucketLifecycle, "Policy"}, { Strings.LabelBootstrapLifecycleWarning, "With lifecycle policy configured on the S3 bucket, stale build artifacts in S3 will be deleted automatically, and will cause fleet creation to fail when created with a build referencing the deleted artifacts."}, + { Strings.LabelBootstrapBucketSelectionLoading, "Loading S3 Buckets..."}, { Strings.LabelBootstrapRegion, "AWS Region"}, { Strings.LabelBootstrapSelectButton, "Update"}, { Strings.LabelBootstrapSelectMode, "Choose existing S3 bucket"}, diff --git a/Runtime/Core/BucketManagement/BucketStore.cs b/Runtime/Core/BucketManagement/BucketStore.cs index 867c4285..db60327a 100644 --- a/Runtime/Core/BucketManagement/BucketStore.cs +++ b/Runtime/Core/BucketManagement/BucketStore.cs @@ -297,7 +297,7 @@ public GetBucketsResponse GetBuckets(GetBucketsRequest request) BucketName = bucketName }); - if (locationResponse.HttpStatusCode == HttpStatusCode.OK && locationResponse.Location.Value == request.Region) + if (locationResponse.HttpStatusCode == HttpStatusCode.OK && ToBucketRegion(locationResponse) == request.Region) { buckets.Add(bucketName); } @@ -329,6 +329,20 @@ public GetBucketsResponse GetBuckets(GetBucketsRequest request) return HandleAwsException(ex, () => new GetBucketsResponse()); } } + private string ToBucketRegion(GetBucketLocationResponse getBucketLocationResponse) + { + string locationValue = getBucketLocationResponse.Location.Value; + // See: https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/TS3Region.html + switch (locationValue) + { + case "": + return "us-east-1"; + case "EU": + return "eu-west-1"; + default: + return locationValue; + } + } public GetAvailableRegionsResponse GetAvailableRegions(GetAvailableRegionsRequest request) {