Deletes the specified rule.
You must remove all targets from a rule using RemoveTargets before you can delete the rule.
When you delete a rule, incoming events might continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
" }, + "DescribeEventBus":{ + "name":"DescribeEventBus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventBusRequest"}, + "output":{"shape":"DescribeEventBusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission.
" + }, "DescribeRule":{ "name":"DescribeRule", "http":{ @@ -119,6 +133,20 @@ ], "documentation":"Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
" }, + "PutPermission":{ + "name":"PutPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPermissionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"PolicyLengthExceededException"}, + {"shape":"InternalException"} + ], + "documentation":"Running PutPermission permits the specified AWS account to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.
For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.
To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts.
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered. Example targets include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, and built-in targets. Note that creating rules with built-in targets is supported only in the AWS Management Console.
For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTarget. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.
Input, InputPath and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify Input, InputPath, or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for CloudWatch Events:
EC2 instances
AWS Lambda functions
Streams in Amazon Kinesis Streams
Delivery streams in Amazon Kinesis Firehose
Amazon ECS tasks
AWS Step Functions state machines
Amazon SNS topics
Amazon SQS queues
Note that creating rules with built-in targets is supported only in the AWS Management Console.
For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission), you can set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn when you run PutTargets. For more information about enabling cross-account events, see PutPermission.
Input, InputPath and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify Input, InputPath, or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Revokes the permission of another AWS account to be able to put events to your default event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
The name of the event bus. Currently, this is always default.
The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
" + }, + "Policy":{ + "shape":"String", + "documentation":"The policy that enables the external account to send events to your account.
" + } + } + }, "DescribeRuleRequest":{ "type":"structure", "required":["Name"], @@ -457,6 +526,19 @@ "max":2048, "min":1 }, + "PolicyLengthExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"The event bus policy is too long. For more information, see the limits.
", + "exception":true + }, + "Principal":{ + "type":"string", + "max":12, + "min":1, + "pattern":"(\\d{12}|\\*)" + }, "PutEventsRequest":{ "type":"structure", "required":["Entries"], @@ -534,6 +616,28 @@ "type":"list", "member":{"shape":"PutEventsResultEntry"} }, + "PutPermissionRequest":{ + "type":"structure", + "required":[ + "Action", + "Principal", + "StatementId" + ], + "members":{ + "Action":{ + "shape":"Action", + "documentation":"The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.
The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify \"*\" to permit any account to put events to your default event bus.
If you specify \"*\", avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.
The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".
" + "documentation":"The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".
" }, "EventPattern":{ "shape":"EventPattern", @@ -625,6 +729,16 @@ "type":"list", "member":{"shape":"PutTargetsResultEntry"} }, + "RemovePermissionRequest":{ + "type":"structure", + "required":["StatementId"], + "members":{ + "StatementId":{ + "shape":"StatementId", + "documentation":"The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
" + } + } + }, "RemoveTargetsRequest":{ "type":"structure", "required":[ @@ -681,7 +795,7 @@ "type":"structure", "members":{ }, - "documentation":"The rule does not exist.
", + "documentation":"An entity that you specified does not exist.
", "exception":true }, "RoleArn":{ @@ -809,6 +923,12 @@ "type":"string", "max":256 }, + "StatementId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9-_]+" + }, "String":{"type":"string"}, "Target":{ "type":"structure", diff --git a/botocore/data/gamelift/2015-10-01/service-2.json b/botocore/data/gamelift/2015-10-01/service-2.json index 483cd5f4..d583c42a 100644 --- a/botocore/data/gamelift/2015-10-01/service-2.json +++ b/botocore/data/gamelift/2015-10-01/service-2.json @@ -26,7 +26,7 @@ {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], - "documentation":"Creates an alias and sets a target fleet. A fleet alias can be used in place of a fleet ID, such as when calling CreateGameSession from a game client or game service or adding destinations to a game session queue. By changing an alias's target fleet, you can switch your players to the new fleet without changing any other component. In production, this feature is particularly useful to redirect your player base seamlessly to the latest game server update.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
" + "documentation":"Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.
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, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.
Alias-related operations include:
" }, "CreateBuild":{ "name":"CreateBuild", @@ -42,7 +42,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServiceException"} ], - "documentation":"Creates a new Amazon GameLift build from a set of game server binary files stored in an Amazon Simple Storage Service (Amazon S3) location. When using this API call, you must create a .zip file containing all of the build files and store it in an Amazon S3 bucket under your AWS account. For help on packaging your build files and creating a build, see Uploading Your Game to Amazon GameLift.
Use this API action ONLY if you are storing your game build files in an Amazon S3 bucket in your AWS account. To create a build using files stored in a directory, use the CLI command upload-build , which uploads the build files from a file location you specify and creates a build.
To create a new build using CreateBuild, identify the storage location and operating system of your game build. You also have the option of specifying a build name and version. If successful, this action creates a new build record with an unique build ID and in INITIALIZED status. Use the API call DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets to host your game.
Creates a new Amazon GameLift build from a set of game server binary files stored in an Amazon Simple Storage Service (Amazon S3) location. To use this API call, create a .zip file containing all of the files for the build and store it in an Amazon S3 bucket under your AWS account. For help on packaging your build files and creating a build, see Uploading Your Game to Amazon GameLift.
Use this API action ONLY if you are storing your game build files in an Amazon S3 bucket. To create a build using files stored locally, use the CLI command upload-build , which uploads the build files from a file location you specify.
To create a new build using CreateBuild, identify the storage location and operating system of your game build. You also have the option of specifying a build name and version. If successful, this action creates a new build record with an unique build ID and in INITIALIZED status. Use the API call DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets to host your game.
Build-related operations include:
" }, "CreateFleet":{ "name":"CreateFleet", @@ -60,7 +60,7 @@ {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.
To create a new fleet, you must specify the following: (1) fleet name, (2) build ID of an uploaded game build, (3) an EC2 instance type, and (4) a runtime configuration that describes which server processes to run on each instance in the fleet. (Although the runtime configuration is not a required parameter, the fleet cannot be successfully created without it.) You can also configure the new fleet with the following settings: fleet description, access permissions for inbound traffic, fleet-wide game session protection, and resource creation limit. If you use Amazon CloudWatch for metrics, you can add the new fleet to a metric group, which allows you to view aggregated metrics for a set of fleets. Once you specify a metric group, the new fleet's metrics are included in the metric group's data.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks:
Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).
Sets the fleet's capacity to 1 \"desired\", which causes Amazon GameLift to start one new EC2 instance.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds.
Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
Sets the fleet's status to ACTIVE once one server process in the fleet is ready to host a game session.
After a fleet is created, use the following actions to change fleet properties and configuration:
UpdateFleetAttributes -- Update fleet metadata, including name and description.
UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.
UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.
PutScalingPolicy -- Create or update rules that are used to set the fleet's capacity (autoscaling).
Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.
To create a new fleet, you must specify the following: (1) fleet name, (2) build ID of an uploaded game build, (3) an EC2 instance type, and (4) a run-time configuration that describes which server processes to run on each instance in the fleet. (Although the run-time configuration is not a required parameter, the fleet cannot be successfully activated without it.)
You can also configure the new fleet with the following settings:
Fleet description
Access permissions for inbound traffic
Fleetwide game session protection
Resource creation limit
If you use Amazon CloudWatch for metrics, you can add the new fleet to a metric group. This allows you to view aggregated metrics for a set of fleets. Once you specify a metric group, the new fleet's metrics are included in the metric group's data.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks:
Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).
Sets the fleet's target capacity to 1 (desired instances), which causes Amazon GameLift to start one new EC2 instance.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds.
Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
Sets the fleet's status to ACTIVE as soon as one server process in the fleet is ready to host a game session.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.
To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing game session properties, including a game session ID with the custom string you provided.
Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.
Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.
By default, newly created game sessions allow new players to join. Use UpdateGameSession to change the game session's player session creation policy.
Available in Amazon GameLift Local.
" + "documentation":"Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.
To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing game session properties, including a game session ID with the custom string you provided.
Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.
Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.
By default, newly created game sessions allow new players to join. Use UpdateGameSession to change the game session's player session creation policy.
Available in Amazon GameLift Local.
Game-session-related operations include:
Game session placements
Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.
Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.
Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.
To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.
" + "documentation":"Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.
Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.
Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.
To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.
Queue-related operations include:
" }, "CreatePlayerSession":{ "name":"CreatePlayerSession", @@ -117,7 +117,7 @@ {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"} ], - "documentation":"Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions.
To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
" + "documentation":"Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions.
To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
Player-session-related operations include:
Game session placements
Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession.
To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
" + "documentation":"Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession.
To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
Player-session-related operations include:
Game session placements
Deletes a fleet alias. This action 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.
" + "documentation":"Deletes an alias. This action 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.
Alias-related operations include:
" }, "DeleteBuild":{ "name":"DeleteBuild", @@ -166,7 +166,7 @@ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. 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.
" + "documentation":"Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. 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.
Build-related operations include:
" }, "DeleteFleet":{ "name":"DeleteFleet", @@ -182,7 +182,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
" + "documentation":"Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.
" + "documentation":"Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.
Queue-related operations include:
" }, "DeleteScalingPolicy":{ "name":"DeleteScalingPolicy", @@ -213,7 +213,7 @@ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"} ], - "documentation":"Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
" + "documentation":"Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves properties for a fleet alias. This operation returns all alias metadata and settings. To get just the fleet ID an alias is currently pointing to, use ResolveAlias.
To get alias properties, specify the alias ID. If successful, an Alias object is returned.
" + "documentation":"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.
Alias-related operations include:
" }, "DescribeBuild":{ "name":"DescribeBuild", @@ -245,7 +245,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
" + "documentation":"Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
Build-related operations include:
" }, "DescribeEC2InstanceLimits":{ "name":"DescribeEC2InstanceLimits", @@ -260,7 +260,7 @@ {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Retrieves the following information for the specified EC2 instance type:
maximum number of instances allowed per AWS account (service limit)
current usage level for the AWS account
Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).
" + "documentation":"Retrieves the following information for the specified EC2 instance type:
maximum number of instances allowed per AWS account (service limit)
current usage level for the AWS account
Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. 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. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. 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. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions 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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves entries from the specified fleet's event log. 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.
" + "documentation":"Retrieves entries from the specified fleet's event log. 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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
" + "documentation":"Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. 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. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions 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.
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. 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. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions 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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
" + "documentation":"Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
Game-session-related operations include:
Game session placements
Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.
" + "documentation":"Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.
Game-session-related operations include:
Game session placements
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.
" + "documentation":"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.
Queue-related operations include:
" }, "DescribeGameSessions":{ "name":"DescribeGameSessions", @@ -406,7 +406,7 @@ {"shape":"UnauthorizedException"}, {"shape":"TerminalRoutingStrategyException"} ], - "documentation":"Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.
To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.
Available in Amazon GameLift Local.
" + "documentation":"Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.
To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.
Available in Amazon GameLift Local.
Game-session-related operations include:
Game session placements
Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a 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 matching the request.
Available in Amazon GameLift Local.
" + "documentation":"Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a 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 matching the request.
Available in Amazon GameLift Local.
Player-session-related operations include:
Game session placements
Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on instances in the fleet.
" + "documentation":"Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
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.
" + "documentation":"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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. 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.
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. 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.
Game-session-related operations include:
Game session placements
Retrieves a collection of alias records 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.
Aliases are not listed in any particular order.
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.
Alias-related operations include:
" }, "ListBuilds":{ "name":"ListBuilds", @@ -532,7 +532,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], - "documentation":"Retrieves build records 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 records are not listed in any particular order.
Retrieves build records 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 records are not listed in any particular order.
Build-related operations include:
" }, "ListFleets":{ "name":"ListFleets", @@ -548,7 +548,7 @@ {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
For example, this policy: \"If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances\" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
" + "documentation":"Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
For example, this policy: \"If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances\" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Retrieves the fleet ID that a specified alias is currently pointing to.
" + "documentation":"Retrieves the fleet ID that a specified alias is currently pointing to.
Alias-related operations include:
" }, "SearchGameSessions":{ "name":"SearchGameSessions", @@ -614,7 +614,7 @@ {"shape":"UnauthorizedException"}, {"shape":"TerminalRoutingStrategyException"} ], - "documentation":"Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.
You can search or sort by the following game session attributes:
gameSessionId -- 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.
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.
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.
hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its maximum number of players. When searching with this attribute, the search value must be true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.
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.
Available in Amazon GameLift Local.
" + "documentation":"Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. A game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.
You can search or sort by the following game session attributes:
gameSessionId -- 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.
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.
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.
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. When searching with this attribute, the search value must be true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.
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.
Game-session-related operations include:
Game session placements
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 IDs and player data for each player you want to join to the new game session
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.
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 IDs and player data for each player you want to join to the new game session
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.
Game-session-related operations include:
Game session placements
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.
" + "documentation":"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.
Game-session-related operations include:
Game session placements
Updates properties for a fleet 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.
" + "documentation":"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.
Alias-related operations include:
" }, "UpdateBuild":{ "name":"UpdateBuild", @@ -678,7 +678,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"Updates metadata in a build record, 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.
" + "documentation":"Updates metadata in a build record, 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.
Build-related operations include:
" }, "UpdateFleetAttributes":{ "name":"UpdateFleetAttributes", @@ -697,7 +697,7 @@ {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
" + "documentation":"Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
" + "documentation":"Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. 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.
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. 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.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
" + "documentation":"Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
Game-session-related operations include:
Game session placements
Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
" + "documentation":"Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Queue-related operations include:
" }, "UpdateRuntimeConfiguration":{ "name":"UpdateRuntimeConfiguration", @@ -786,7 +786,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InvalidFleetStatusException"} ], - "documentation":"Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on 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 an ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.
" + "documentation":"Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.
To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
" } }, - "documentation":"Properties describing a fleet alias.
Alias-related operations include:
" + "documentation":"Properties describing a fleet alias.
Alias-related operations include:
" }, "AliasId":{ "type":"string", @@ -1018,11 +1018,11 @@ }, "ServerLaunchPath":{ "shape":"NonZeroAndMaxString", - "documentation":"This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)
This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)
Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration; otherwise the request will fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a runtime configuration will continue to work.)
Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)
Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group, or use a new name to create a new metric group. Currently, a fleet can only be included in one metric group at a time.
" + "documentation":"Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
" } }, "documentation":"Represents the input for a request action.
" @@ -1515,7 +1515,7 @@ }, "StatusFilter":{ "shape":"NonZeroAndMaxString", - "documentation":"Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Unique identifier for a fleet to get the runtime configuration for.
" + "documentation":"Unique identifier for a fleet to get the run-time configuration for.
" } }, "documentation":"Represents the input for a request action.
" @@ -1829,7 +1829,7 @@ "documentation":"Number of instances in the fleet that are no longer active but haven't yet been terminated.
" } }, - "documentation":"Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
" + "documentation":"Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Type of event being logged.
" + "documentation":"Type of event being logged. The following events are currently in use:
General events:
GENERIC_EVENT – An unspecified event has occurred.
Fleet creation events:
FLEET_CREATED – A fleet record 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 Amazon 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 sucessfully. Access the logs by using the URL in PreSignedLogUrl).
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG – The build process was successful, and the Amazon GameLift is now verifying that the game server launch path(s), which are specified in the fleet's run-time configuration, exist. If any listed launch path exists, Amazon 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 run-time configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl). Once the game server is launched, failures and crashes are logged; these logs can be downloaded from the Amazon GameLift console.
FLEET_STATE_VALIDATING – Fleet status changed from DOWNLOADING to VALIDATING.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND – Validation of the run-time validation 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 validation 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. A possible reason for failure is that the game server is not reporting \"process ready\" to the Amazon GameLift service.
FLEET_STATE_ACTIVE – The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
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.
Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
" + }, + "PreSignedLogUrl":{ + "shape":"NonZeroAndMaxString", + "documentation":"Location of stored logs with additional detail related to the event, useful for debugging issues. The URL is valid for 15 minutes. Fleet creation logs can also be accessed through the Amazon GameLift console.
" } }, - "documentation":"Log entry describing an event involving Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
" + "documentation":"Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
" }, "EventCode":{ "type":"string", @@ -1940,7 +1944,10 @@ "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", - "GAME_SESSION_ACTIVATION_TIMEOUT" + "GAME_SESSION_ACTIVATION_TIMEOUT", + "FLEET_CREATION_EXTRACTING_BUILD", + "FLEET_CREATION_RUNNING_INSTALLER", + "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG" ] }, "EventList":{ @@ -1984,15 +1991,15 @@ }, "ServerLaunchPath":{ "shape":"NonZeroAndMaxString", - "documentation":"Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.
" + "documentation":"Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.
" }, "ServerLaunchParameters":{ "shape":"NonZeroAndMaxString", - "documentation":"Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.
" + "documentation":"Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.
" }, "LogPaths":{ "shape":"StringList", - "documentation":"Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift will automatically upload logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for a fleets that are in a fleet metric group. Currently, a fleet can be included in only one metric group at a time.
" + "documentation":"Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
" } }, - "documentation":"General properties describing a fleet.
" + "documentation":"General properties describing a fleet.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Current status of fleet capacity.
" } }, - "documentation":"Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
" + "documentation":"Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
" } }, - "documentation":"Current status of fleet utilization, including the number of game and player sessions being hosted.
" + "documentation":"Current status of fleet utilization, including the number of game and player sessions being hosted.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
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.
" } }, - "documentation":"Properties describing a game session.
" + "documentation":"Properties describing a game session.
Game-session-related operations include:
Game session placements
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
" } }, - "documentation":"Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.
The length of time that placement requests can wait in the queue before timing out.
A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.
Queue-related operations include the following:
" + "documentation":"Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
Queue-related operations include:
The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.
The length of time that placement requests can wait in the queue before timing out.
A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.
Queue-related operations include the following:
" }, "GameSessionQueueDestination":{ "type":"structure", @@ -2335,7 +2342,7 @@ "documentation":"Amazon Resource Name (ARN) 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.
" } }, - "documentation":"Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
" + "documentation":"Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
Queue-related operations include:
" }, "GameSessionQueueDestinationList":{ "type":"list", @@ -2453,7 +2460,7 @@ }, "Status":{ "shape":"InstanceStatus", - "documentation":"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 runtime configuration.
ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon 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.
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 Amazon 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.
Unique identifier for a player session.
" } }, - "documentation":"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.
" + "documentation":"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.
Player-session-related operations include:
Game session placements
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.
" } }, - "documentation":"Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
Latency policy-related operations include:
" + "documentation":"Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
Queue-related operations include:
" }, "PlayerLatencyPolicyList":{ "type":"list", @@ -2885,7 +2892,7 @@ "documentation":"Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
" } }, - "documentation":"Properties describing a player session. A player session represents either a player reservation for a game session or actual player activity in a game session. 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.
Player session-related operations include:
" + "documentation":"Properties describing a player session. A player session represents either a player reservation for a game session or actual player activity in a game session. 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.
Player-session-related operations include:
Game session placements
Message text to be used with a terminal routing strategy.
" } }, - "documentation":"Routing configuration for a fleet alias.
" + "documentation":"Routing configuration for a fleet alias.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
" + "documentation":"Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
" + "documentation":"Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version.
The key purpose of a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters.
A Amazon GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.
A collection of server process configurations that describe what processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet launches the server processes specified in the run-time configuration and launches new ones as existing processes end. Each instance regularly checks for an updated run-time configuration and follows the new instructions.
The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different build executables, such as your game server executable and a related program, or two or more different versions of a game server. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.
A Amazon GameLift instance is limited to 50 processes running simultaneously. A run-time configuration must specify fewer than this limit. To calculate the total number of processes specified in a run-time configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the run-time configuration.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions – number of game sessions in the process of being created (game session status = ACTIVATING).
ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE).
CurrentPlayerSessions – number of active or reserved player sessions (player session status = ACTIVE or RESERVED).
AvailablePlayerSessions – number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).
ActiveInstances – number of instances currently running a game session.
IdleInstances – number of instances not currently running a game session.
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
" + "documentation":"Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Fleet-related operations include:
Describe fleets:
Update fleets:
Manage fleet capacity:
PutScalingPolicy (automatic scaling)
DescribeScalingPolicies (automatic scaling)
DeleteScalingPolicy (automatic scaling)
Names of metric groups to include this fleet with. A fleet metric group is used in Amazon CloudWatch to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group, or use a new name to create a new metric group. Currently, a fleet can only be included in one metric group at a time.
" + "documentation":"Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
" } }, "documentation":"Represents the input for a request action.
" @@ -3583,11 +3590,11 @@ "members":{ "FleetId":{ "shape":"FleetId", - "documentation":"Unique identifier for a fleet to update runtime configuration for.
" + "documentation":"Unique identifier for a fleet to update run-time configuration for.
" }, "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", - "documentation":"Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
" + "documentation":"Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
" } }, "documentation":"Represents the input for a request action.
" @@ -3597,7 +3604,7 @@ "members":{ "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", - "documentation":"The runtime configuration currently in force. If the update was successful, this object matches the one in the request.
" + "documentation":"The run-time configuration currently in force. If the update was successful, this object matches the one in the request.
" } }, "documentation":"Represents the returned data in response to a request action.
" @@ -3607,5 +3614,5 @@ "min":0 } }, - "documentation":"Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Amazon GameLift provides tools to acquire computing resources and deploy game servers, scale game server capacity to meet player demand, and track in-depth metrics on player usage and server performance.
The Amazon GameLift service API includes important features:
Find game sessions and match players to games – Retrieve information on available game sessions; create new game sessions; send player requests to join a game session.
Configure and manage game server resources – Manage builds, fleets, queues, and aliases; set autoscaling policies; retrieve logs and metrics.
This reference guide describes the low-level service API for Amazon GameLift. We recommend using either the Amazon Web Services software development kit (AWS SDK), available in multiple languages, or the AWS command-line interface (CLI) tool. Both of these align with the low-level service API. In addition, you can use the AWS Management Console for Amazon GameLift for many administrative actions.
You can use some API actions with Amazon GameLift Local, a testing tool that lets you test your game integration locally before deploying on Amazon GameLift. You can call these APIs from the AWS CLI or programmatically; API calls to Amazon GameLift Local servers perform exactly as they do when calling Amazon GameLift web servers. For more information on using Amazon GameLift Local, see Testing an Integration.
MORE RESOURCES
Amazon GameLift Developer Guide – Learn more about Amazon GameLift features and how to use them.
Lumberyard and Amazon GameLift Tutorials – Get started fast with walkthroughs and sample projects.
GameDev Blog – Stay up to date with new features and techniques.
GameDev Forums – Connect with the GameDev community.
Amazon GameLift Document History – See changes to the Amazon GameLift service, SDKs, and documentation, as well as links to release notes.
API SUMMARY
This list offers a functional overview of the Amazon GameLift service API.
Finding Games and Joining Players
You can enable players to connect to game servers on Amazon GameLift from a game client or through a game service (such as a matchmaking service). You can use these operations to discover actively running game or start new games. You can also match players to games, either singly or as a group.
Discover existing game sessions
SearchGameSessions – Get all available game sessions or search for game sessions that match a set of criteria. Available in Amazon GameLift Local.
Start a new game session
Game session placement – Use a queue to process new game session requests and create game sessions on fleets designated for the queue.
StartGameSessionPlacement – Request a new game session placement and add one or more players to it.
DescribeGameSessionPlacement – Get details on a placement request, including status.
StopGameSessionPlacement – Cancel a placement request.
CreateGameSession – Start a new game session on a specific fleet. Available in Amazon GameLift Local.
Manage game session objects
DescribeGameSessions – Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in Amazon GameLift Local.
DescribeGameSessionDetails – Retrieve metadata and the game session protection setting for one or more game sessions.
UpdateGameSession – Change game session settings, such as maximum player count and join policy.
GetGameSessionLogUrl – Get the location of saved logs for a game session.
Manage player sessions objects
CreatePlayerSession – Send a request for a player to join a game session. Available in Amazon GameLift Local.
CreatePlayerSessions – Send a request for multiple players to join a game session. Available in Amazon GameLift Local.
DescribePlayerSessions – Get details on player activity, including status, playing time, and player data. Available in Amazon GameLift Local.
Setting Up and Managing Game Servers
When setting up Amazon GameLift, first create a game build and upload the files to Amazon GameLift. Then use these operations to set up a fleet of resources to run your game servers. Manage games to scale capacity, adjust configuration settings, access raw utilization data, and more.
Manage game builds
CreateBuild – Create a new build by uploading files stored in an Amazon S3 bucket. (To create a build stored at a local file location, use the AWS CLI command upload-build.)
ListBuilds – Get a list of all builds uploaded to a Amazon GameLift region.
DescribeBuild – Retrieve information associated with a build.
UpdateBuild – Change build metadata, including build name and version.
DeleteBuild – Remove a build from Amazon GameLift.
Manage fleets
CreateFleet – Configure and activate a new fleet to run a build's game servers.
DeleteFleet – Terminate a fleet that is no longer running game servers or hosting players.
View / update fleet configurations.
ListFleets – Get a list of all fleet IDs in a Amazon GameLift region (all statuses).
DescribeFleetAttributes / UpdateFleetAttributes – View or change a fleet's metadata and settings for game session protection and resource creation limits.
DescribeFleetPortSettings / UpdateFleetPortSettings – View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet.
DescribeRuntimeConfiguration / UpdateRuntimeConfiguration – View or change what server processes (and how many) to run on each instance in a fleet.
DescribeInstances – Get information on each instance in a fleet, including instance ID, IP address, and status.
Control fleet capacity
DescribeEC2InstanceLimits – Retrieve maximum number of instances allowed for the current AWS account and the current usage level.
DescribeFleetCapacity / UpdateFleetCapacity – Retrieve the capacity settings and the current number of instances in a fleet; adjust fleet capacity settings to scale up or down.
Autoscale – Manage autoscaling rules and apply them to a fleet.
PutScalingPolicy – Create a new autoscaling policy, or update an existing one.
DescribeScalingPolicies – Retrieve an existing autoscaling policy.
DeleteScalingPolicy – Delete an autoscaling policy and stop it from affecting a fleet's capacity.
Access fleet activity statistics
DescribeFleetUtilization – Get current data on the number of server processes, game sessions, and players currently active on a fleet.
DescribeFleetEvents – Get a fleet's logged events for a specified time span.
DescribeGameSessions – Retrieve metadata associated with one or more game sessions, including length of time active and current player count.
Remotely access an instance
GetInstanceAccess – Request access credentials needed to remotely connect to a specified instance in a fleet.
Manage fleet aliases
CreateAlias – Define a new alias and optionally assign it to a fleet.
ListAliases – Get all fleet aliases defined in a Amazon GameLift region.
DescribeAlias – Retrieve information on an existing alias.
UpdateAlias – Change settings for a alias, such as redirecting it from one fleet to another.
DeleteAlias – Remove an alias from the region.
ResolveAlias – Get the fleet ID that a specified alias points to.
Manage game session queues
CreateGameSessionQueue – Create a queue for processing requests for new game sessions.
DescribeGameSessionQueues – Get data on all game session queues defined in a Amazon GameLift region.
UpdateGameSessionQueue – Change the configuration of a game session queue.
DeleteGameSessionQueue – Remove a game session queue from the region.
Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Amazon GameLift provides tools for the following tasks: (1) acquire computing resources and deploy game servers, (2) scale game server capacity to meet player demand, (3) host game sessions and manage player access, and (4) track in-depth metrics on player usage and server performance.
The Amazon GameLift service API includes two important function sets:
Manage game sessions and player access – Retrieve information on available game sessions; create new game sessions; send player requests to join a game session.
Configure and manage game server resources – Manage builds, fleets, queues, and aliases; set autoscaling policies; retrieve logs and metrics.
This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools:
The Amazon Web Services software development kit (AWS SDK) is available in multiple languages including C++ and C#. Use the SDK to access the API programmatically from an application, such as a game client.
The AWS command-line interface (CLI) tool is primarily useful for handling administrative actions, such as setting up and managing Amazon GameLift settings and resources. You can use the AWS CLI to manage all of your AWS services.
The AWS Management Console for Amazon GameLift provides a web interface to manage your Amazon GameLift settings and resources. The console includes a dashboard for tracking key resources, includings builds and fleets, and displays usage and performance metrics for your games as customizable graphs.
Amazon GameLift Local is a tool for testing your game's integration with Amazon GameLift before deploying it on the service. This tools supports a subset of key API actions, which can be called from either the AWS CLI or programmatically. See Testing an Integration.
MORE RESOURCES
Amazon GameLift Developer Guide – Learn more about Amazon GameLift features and how to use them.
Lumberyard and Amazon GameLift Tutorials – Get started fast with walkthroughs and sample projects.
GameDev Blog – Stay up to date with new features and techniques.
GameDev Forums – Connect with the GameDev community.
Amazon GameLift Document History – See changes to the Amazon GameLift service, SDKs, and documentation, as well as links to release notes.
API SUMMARY
This list offers a functional overview of the Amazon GameLift service API.
Managing Games and Players
These actions allow you to start new game sessions, find existing game sessions, track status and other game session information, and enable access for players to join game sessions.
Discover existing game sessions
SearchGameSessions – Get all available game sessions or search for game sessions that match a set of criteria.
Start a new game session
Game session placement – Use a queue to process requests for new game sessions and place them on the best available fleet. Placement requests are asynchronous; game sessions are started whenever acceptable resources become available.
StartGameSessionPlacement – Request a new game session placement and add one or more players to it.
DescribeGameSessionPlacement – Get details on a placement request, including status.
StopGameSessionPlacement – Cancel a placement request.
CreateGameSession – Request a new game session on a specific fleet. Available in Amazon GameLift Local.
Manage game session data
DescribeGameSessions – Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in Amazon GameLift Local.
DescribeGameSessionDetails – Retrieve metadata and the game session protection setting for one or more game sessions.
UpdateGameSession – Change game session settings, such as maximum player count and join policy.
GetGameSessionLogUrl – Get the location of saved logs for a game session.
Manage player sessions
CreatePlayerSession – Send a request for a player to join a game session. Available in Amazon GameLift Local.
CreatePlayerSessions – Send a request for multiple players to join a game session. Available in Amazon GameLift Local.
DescribePlayerSessions – Get details on player activity, including status, playing time, and player data. Available in Amazon GameLift Local.
Setting Up and Managing Game Servers
When setting up Amazon GameLift resources for your game, you first create a game build and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more.
Manage game builds
CreateBuild – Create a new build using files stored in an Amazon S3 bucket. (Update uploading permissions with RequestUploadCredentials.) To create a build and upload files from a local path, use the AWS CLI command upload-build.
ListBuilds – Get a list of all builds uploaded to a Amazon GameLift region.
DescribeBuild – Retrieve information associated with a build.
UpdateBuild – Change build metadata, including build name and version.
DeleteBuild – Remove a build from Amazon GameLift.
Manage fleets
CreateFleet – Configure and activate a new fleet to run a build's game servers.
ListFleets – Get a list of all fleet IDs in a Amazon GameLift region (all statuses).
DeleteFleet – Terminate a fleet that is no longer running game servers or hosting players.
View / update fleet configurations.
DescribeFleetAttributes / UpdateFleetAttributes – View or change a fleet's metadata and settings for game session protection and resource creation limits.
DescribeFleetPortSettings / UpdateFleetPortSettings – View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet.
DescribeRuntimeConfiguration / UpdateRuntimeConfiguration – View or change what server processes (and how many) to run on each instance in a fleet.
Control fleet capacity
DescribeEC2InstanceLimits – Retrieve maximum number of instances allowed for the current AWS account and the current usage level.
DescribeFleetCapacity / UpdateFleetCapacity – Retrieve the capacity settings and the current number of instances in a fleet; adjust fleet capacity settings to scale up or down.
Autoscale – Manage autoscaling rules and apply them to a fleet.
PutScalingPolicy – Create a new autoscaling policy, or update an existing one.
DescribeScalingPolicies – Retrieve an existing autoscaling policy.
DeleteScalingPolicy – Delete an autoscaling policy and stop it from affecting a fleet's capacity.
Access fleet activity statistics
DescribeFleetUtilization – Get current data on the number of server processes, game sessions, and players currently active on a fleet.
DescribeFleetEvents – Get a fleet's logged events for a specified time span.
DescribeGameSessions – Retrieve metadata associated with one or more game sessions, including length of time active and current player count.
Remotely access an instance
DescribeInstances – Get information on each instance in a fleet, including instance ID, IP address, and status.
GetInstanceAccess – Request access credentials needed to remotely connect to a specified instance in a fleet.
Manage fleet aliases
CreateAlias – Define a new alias and optionally assign it to a fleet.
ListAliases – Get all fleet aliases defined in a Amazon GameLift region.
DescribeAlias – Retrieve information on an existing alias.
UpdateAlias – Change settings for a alias, such as redirecting it from one fleet to another.
DeleteAlias – Remove an alias from the region.
ResolveAlias – Get the fleet ID that a specified alias points to.
Manage game session queues
CreateGameSessionQueue – Create a queue for processing requests for new game sessions.
DescribeGameSessionQueues – Get data on all game session queues defined in a Amazon GameLift region.
UpdateGameSessionQueue – Change the configuration of a game session queue.
DeleteGameSessionQueue – Remove a game session queue from the region.
The desired data set type.
The desired data set type.
Associates a product with a portfolio.
" }, + "AssociateTagOptionWithResource":{ + "name":"AssociateTagOptionWithResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateTagOptionWithResourceInput"}, + "output":{"shape":"AssociateTagOptionWithResourceOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"Associate a TagOption identifier with a resource identifier.
" + }, "CreateConstraint":{ "name":"CreateConstraint", "http":{ @@ -82,7 +100,8 @@ "output":{"shape":"CreatePortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"TagOptionNotMigratedException"} ], "documentation":"Creates a new portfolio.
" }, @@ -111,7 +130,8 @@ "output":{"shape":"CreateProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"TagOptionNotMigratedException"} ], "documentation":"Creates a new product.
" }, @@ -130,6 +150,21 @@ ], "documentation":"Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
See the bottom of this topic for an example JSON request.
" }, + "CreateTagOption":{ + "name":"CreateTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagOptionInput"}, + "output":{"shape":"CreateTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Create a new TagOption.
" + }, "DeleteConstraint":{ "name":"DeleteConstraint", "http":{ @@ -155,7 +190,8 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, - {"shape":"ResourceInUseException"} + {"shape":"ResourceInUseException"}, + {"shape":"TagOptionNotMigratedException"} ], "documentation":"Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.
" }, @@ -183,7 +219,8 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, - {"shape":"InvalidParametersException"} + {"shape":"InvalidParametersException"}, + {"shape":"TagOptionNotMigratedException"} ], "documentation":"Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.
" }, @@ -307,7 +344,7 @@ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.
Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to the ProvisionProduct operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct with empty TagOption values cause the error \"Parameter validation failed: Missing required parameter in Tags[N]:Value \". Calls to ProvisionProduct with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value \"sc-tagoption-conflict-portfolioId-productId\".
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
" }, + "DescribeTagOption":{ + "name":"DescribeTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagOptionInput"}, + "output":{"shape":"DescribeTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes a TagOption.
" + }, "DisassociatePrincipalFromPortfolio":{ "name":"DisassociatePrincipalFromPortfolio", "http":{ @@ -346,10 +397,25 @@ "output":{"shape":"DisassociateProductFromPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"} ], "documentation":"Disassociates the specified product from the specified portfolio.
" }, + "DisassociateTagOptionFromResource":{ + "name":"DisassociateTagOptionFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateTagOptionFromResourceInput"}, + "output":{"shape":"DisassociateTagOptionFromResourceOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disassociates a TagOption from a resource.
" + }, "ListAcceptedPortfolioShares":{ "name":"ListAcceptedPortfolioShares", "http":{ @@ -472,6 +538,35 @@ ], "documentation":"Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
" }, + "ListResourcesForTagOption":{ + "name":"ListResourcesForTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesForTagOptionInput"}, + "output":{"shape":"ListResourcesForTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"Lists resources associated with a TagOption.
" + }, + "ListTagOptions":{ + "name":"ListTagOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagOptionsInput"}, + "output":{"shape":"ListTagOptionsOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"Lists detailed TagOptions information.
" + }, "ProvisionProduct":{ "name":"ProvisionProduct", "http":{ @@ -485,7 +580,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"DuplicateResourceException"} ], - "documentation":"Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation.
" + "documentation":"Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation. The error \"Parameter validation failed: Missing required parameter in Tags[N]:Value\" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.
Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.
" }, @@ -592,7 +688,8 @@ "output":{"shape":"UpdateProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParametersException"} + {"shape":"InvalidParametersException"}, + {"shape":"TagOptionNotMigratedException"} ], "documentation":"Updates an existing product.
" }, @@ -623,6 +720,22 @@ {"shape":"InvalidParametersException"} ], "documentation":"Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.
" + }, + "UpdateTagOption":{ + "name":"UpdateTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTagOptionInput"}, + "output":{"shape":"UpdateTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"Updates an existing TagOption.
" } }, "shapes":{ @@ -749,6 +862,28 @@ "members":{ } }, + "AssociateTagOptionWithResourceInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagOptionId" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"The resource identifier.
" + }, + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"The TagOption identifier.
" + } + } + }, + "AssociateTagOptionWithResourceOutput":{ + "type":"structure", + "members":{ + } + }, "AttributeValue":{"type":"string"}, "ConstraintDescription":{ "type":"string", @@ -1058,6 +1193,32 @@ } } }, + "CreateTagOptionInput":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"The TagOption key.
" + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"The TagOption value.
" + } + } + }, + "CreateTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"The resulting detailed TagOption information.
" + } + } + }, "CreatedTime":{"type":"timestamp"}, "CreationTime":{"type":"timestamp"}, "DefaultValue":{"type":"string"}, @@ -1225,6 +1386,10 @@ "Tags":{ "shape":"Tags", "documentation":"Tags associated with the portfolio.
" + }, + "TagOptions":{ + "shape":"TagOptionDetails", + "documentation":"TagOptions associated with the portfolio.
" } } }, @@ -1256,6 +1421,10 @@ "Tags":{ "shape":"Tags", "documentation":"Tags associated with the product.
" + }, + "TagOptions":{ + "shape":"TagOptionDetails", + "documentation":"List of TagOptions associated with the product.
" } } }, @@ -1357,7 +1526,7 @@ }, "Verbose":{ "shape":"Verbose", - "documentation":"Selects verbose results. If set to true, the CloudFormation template is returned.
" + "documentation":"Enable a verbose level of details for the provisioning artifact.
" } } }, @@ -1417,6 +1586,10 @@ "UsageInstructions":{ "shape":"UsageInstructions", "documentation":"Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
List of TagOptions associated with the provisioned provisioning parameters.
" } } }, @@ -1459,6 +1632,25 @@ } } }, + "DescribeTagOptionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TagOptionId", + "documentation":"The identifier of the TagOption.
" + } + } + }, + "DescribeTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"The resulting detailed TagOption information.
" + } + } + }, "Description":{"type":"string"}, "DisassociatePrincipalFromPortfolioInput":{ "type":"structure", @@ -1512,6 +1704,28 @@ "members":{ } }, + "DisassociateTagOptionFromResourceInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagOptionId" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"Identifier of the resource from which to disassociate the TagOption.
" + }, + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"Identifier of the TagOption to disassociate from the resource.
" + } + } + }, + "DisassociateTagOptionFromResourceOutput":{ + "type":"structure", + "members":{ + } + }, "DuplicateResourceException":{ "type":"structure", "members":{ @@ -1543,6 +1757,13 @@ "documentation":"One or more parameters provided to the operation are invalid.
", "exception":true }, + "InvalidStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"An attempt was made to modify a resource that is in an invalid state. Inspect the resource you are using for this operation to ensure that all resource states are valid before retrying the operation.
", + "exception":true + }, "LastRequestId":{"type":"string"}, "LaunchPathSummaries":{ "type":"list", @@ -1656,7 +1877,7 @@ }, "ProductId":{ "shape":"Id", - "documentation":"The product identifier.. Identifies the product for which to retrieve LaunchPathSummaries information.
The product identifier. Identifies the product for which to retrieve LaunchPathSummaries information.
The search filter to limit results when listing request history records.
" }, + "ListResourcesForTagOptionInput":{ + "type":"structure", + "required":["TagOptionId"], + "members":{ + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"Identifier of the TagOption.
" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"Resource type.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.
The resulting detailed resource information.
" + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.
The ListTagOptionsFilters key.
" + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"The ListTagOptionsFilters value.
" + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"The ListTagOptionsFilters active state.
" + } + }, + "documentation":"The ListTagOptions filters.
" + }, + "ListTagOptionsInput":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListTagOptionsFilters", + "documentation":"The list of filters with which to limit search results. If no search filters are specified, the output is all TagOptions.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.
The resulting detailed TagOption information.
" + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.
The provisioning artifact identifier.
" + "documentation":"The identifier of the provisioning artifact.
" }, "Name":{ "shape":"ProvisioningArtifactName", - "documentation":"The provisioning artifact name.
" + "documentation":"The name of the provisioning artifact.
" }, "Description":{ "shape":"ProvisioningArtifactDescription", - "documentation":"The provisioning artifact description.
" + "documentation":"The description of the provisioning artifact.
" }, "CreatedTime":{ "shape":"ProvisioningArtifactCreatedTime", @@ -2428,7 +2732,7 @@ "documentation":"The provisioning artifact metadata. This data is used with products created by AWS Marketplace.
" } }, - "documentation":"Summary information about a provisioning artifact.
" + "documentation":"Stores summary information about a provisioning artifact.
" }, "ProvisioningArtifactType":{ "type":"string", @@ -2473,7 +2777,7 @@ }, "Status":{ "shape":"RecordStatus", - "documentation":"The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet started.
IN_PROGRESS - The requested operation is in-progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet started.
IN_PROGRESS - The requested operation is in-progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
Identifier of the resource.
" + }, + "ARN":{ + "shape":"ResourceDetailARN", + "documentation":"ARN of the resource.
" + }, + "Name":{ + "shape":"ResourceDetailName", + "documentation":"Name of the resource.
" + }, + "Description":{ + "shape":"ResourceDetailDescription", + "documentation":"Description of the resource.
" + }, + "CreatedTime":{ + "shape":"ResourceDetailCreatedTime", + "documentation":"Creation time of the resource.
" + } + }, + "documentation":"Detailed resource information.
" + }, + "ResourceDetailARN":{"type":"string"}, + "ResourceDetailCreatedTime":{"type":"timestamp"}, + "ResourceDetailDescription":{"type":"string"}, + "ResourceDetailId":{"type":"string"}, + "ResourceDetailName":{"type":"string"}, + "ResourceDetails":{ + "type":"list", + "member":{"shape":"ResourceDetail"} + }, + "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", "members":{ @@ -2642,6 +2982,7 @@ "documentation":"The specified resource was not found.
", "exception":true }, + "ResourceType":{"type":"string"}, "ScanProvisionedProductsInput":{ "type":"structure", "members":{ @@ -2808,7 +3149,7 @@ "documentation":"The desired value for this key.
" } }, - "documentation":"Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
" + "documentation":"Key-value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
" }, "TagKey":{ "type":"string", @@ -2820,6 +3161,79 @@ "type":"list", "member":{"shape":"TagKey"} }, + "TagOptionActive":{"type":"boolean"}, + "TagOptionDetail":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"The TagOptionDetail key.
" + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"The TagOptionDetail value.
" + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"The TagOptionDetail active state.
" + }, + "Id":{ + "shape":"TagOptionId", + "documentation":"The TagOptionDetail identifier.
" + } + }, + "documentation":"The TagOption details.
" + }, + "TagOptionDetails":{ + "type":"list", + "member":{"shape":"TagOptionDetail"} + }, + "TagOptionId":{ + "type":"string", + "max":100, + "min":1 + }, + "TagOptionKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagOptionNotMigratedException":{ + "type":"structure", + "members":{ + }, + "documentation":"An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Please use the AWS console to perform the migration process before retrying the operation.
", + "exception":true + }, + "TagOptionSummaries":{ + "type":"list", + "member":{"shape":"TagOptionSummary"} + }, + "TagOptionSummary":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"The TagOptionSummary key.
" + }, + "Values":{ + "shape":"TagOptionValues", + "documentation":"The TagOptionSummary value.
" + } + }, + "documentation":"The TagOption summary key-value pair.
" + }, + "TagOptionValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagOptionValues":{ + "type":"list", + "member":{"shape":"TagOptionValue"} + }, "TagValue":{ "type":"string", "max":256, @@ -3128,6 +3542,33 @@ "type":"list", "member":{"shape":"UpdateProvisioningParameter"} }, + "UpdateTagOptionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TagOptionId", + "documentation":"The identifier of the constraint to update.
" + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"The updated value.
" + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"The updated active state.
" + } + } + }, + "UpdateTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"The resulting detailed TagOption information.
" + } + } + }, "UpdatedTime":{"type":"timestamp"}, "UsageInstruction":{ "type":"structure", diff --git a/botocore/data/ssm/2014-11-06/service-2.json b/botocore/data/ssm/2014-11-06/service-2.json index 5e246081..a3a8e511 100644 --- a/botocore/data/ssm/2014-11-06/service-2.json +++ b/botocore/data/ssm/2014-11-06/service-2.json @@ -151,6 +151,22 @@ ], "documentation":"Creates a patch baseline.
" }, + "CreateResourceDataSync":{ + "name":"CreateResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceDataSyncRequest"}, + "output":{"shape":"CreateResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ResourceDataSyncCountExceededException"}, + {"shape":"ResourceDataSyncAlreadyExistsException"}, + {"shape":"ResourceDataSyncInvalidConfigurationException"} + ], + "documentation":"Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Creating a Resource Data Sync.
" + }, "DeleteActivation":{ "name":"DeleteActivation", "http":{ @@ -253,6 +269,20 @@ ], "documentation":"Deletes a patch baseline.
" }, + "DeleteResourceDataSync":{ + "name":"DeleteResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceDataSyncRequest"}, + "output":{"shape":"DeleteResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ResourceDataSyncNotFoundException"} + ], + "documentation":"Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
" + }, "DeregisterManagedInstance":{ "name":"DeregisterManagedInstance", "http":{ @@ -850,7 +880,7 @@ {"shape":"InvalidKeyId"}, {"shape":"InvalidNextToken"} ], - "documentation":"Retrieve parameters in a specific hierarchy. For more information, see Using Parameter Hierarchies.
" + "documentation":"Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
" }, "GetPatchBaseline":{ "name":"GetPatchBaseline", @@ -975,6 +1005,20 @@ ], "documentation":"A list of inventory items returned by the request.
" }, + "ListResourceDataSync":{ + "name":"ListResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceDataSyncRequest"}, + "output":{"shape":"ListResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
A name for the configuration.
" + }, + "S3Destination":{ + "shape":"ResourceDataSyncS3Destination", + "documentation":"Amazon S3 configuration details for the sync.
" + } + } + }, + "CreateResourceDataSyncResult":{ + "type":"structure", + "members":{ + } + }, "CreatedDate":{"type":"timestamp"}, "CustomSchemaCountLimitExceededException":{ "type":"structure", @@ -2660,6 +2726,21 @@ } } }, + "DeleteResourceDataSyncRequest":{ + "type":"structure", + "required":["SyncName"], + "members":{ + "SyncName":{ + "shape":"ResourceDataSyncName", + "documentation":"The name of the configuration to delete.
" + } + } + }, + "DeleteResourceDataSyncResult":{ + "type":"structure", + "members":{ + } + }, "DeregisterManagedInstanceRequest":{ "type":"structure", "required":["InstanceId"], @@ -4602,10 +4683,10 @@ "members":{ "message":{ "shape":"String", - "documentation":"A hierarchy can have a maximum of five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Develop a Parameter Hierarchy.
" + "documentation":"A hierarchy can have a maximum of five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
" } }, - "documentation":"A hierarchy can have a maximum of five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Develop a Parameter Hierarchy.
", + "documentation":"A hierarchy can have a maximum of five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
", "exception":true }, "HierarchyTypeMismatchException":{ @@ -5630,6 +5711,16 @@ "type":"list", "member":{"shape":"TagKey"} }, + "LastResourceDataSyncStatus":{ + "type":"string", + "enum":[ + "Successful", + "Failed", + "InProgress" + ] + }, + "LastResourceDataSyncTime":{"type":"timestamp"}, + "LastSuccessfulResourceDataSyncTime":{"type":"timestamp"}, "ListAssociationsRequest":{ "type":"structure", "members":{ @@ -5865,6 +5956,33 @@ } } }, + "ListResourceDataSyncRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"A token to start the list. Use this token to get the next set of results.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", + "box":true + } + } + }, + "ListResourceDataSyncResult":{ + "type":"structure", + "members":{ + "ResourceDataSyncItems":{ + "shape":"ResourceDataSyncItemList", + "documentation":"A list of your current Resource Data Sync configurations and their statuses.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of items to return. Use this token to get the next set of results.
" + } + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":[ @@ -7373,6 +7491,124 @@ "members":{ } }, + "ResourceDataSyncAlreadyExistsException":{ + "type":"structure", + "members":{ + "SyncName":{"shape":"ResourceDataSyncName"} + }, + "documentation":"A sync configuration with the same name already exists.
", + "exception":true + }, + "ResourceDataSyncCountExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You have exceeded the allowed maximum sync configurations.
", + "exception":true + }, + "ResourceDataSyncCreatedTime":{"type":"timestamp"}, + "ResourceDataSyncInvalidConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The specified sync configuration is invalid.
", + "exception":true + }, + "ResourceDataSyncItem":{ + "type":"structure", + "members":{ + "SyncName":{ + "shape":"ResourceDataSyncName", + "documentation":"The name of the Resource Data Sync.
" + }, + "S3Destination":{ + "shape":"ResourceDataSyncS3Destination", + "documentation":"Configuration information for the target Amazon S3 bucket.
" + }, + "LastSyncTime":{ + "shape":"LastResourceDataSyncTime", + "documentation":"The last time the configuration attempted to sync (UTC).
" + }, + "LastSuccessfulSyncTime":{ + "shape":"LastSuccessfulResourceDataSyncTime", + "documentation":"The last time the sync operations returned a status of SUCCESSFUL (UTC).
The status reported by the last sync.
" + }, + "SyncCreatedTime":{ + "shape":"ResourceDataSyncCreatedTime", + "documentation":"The date and time the configuration was created (UTC).
" + } + }, + "documentation":"Information about a Resource Data Sync configuration, including its current status and last successful sync.
" + }, + "ResourceDataSyncItemList":{ + "type":"list", + "member":{"shape":"ResourceDataSyncItem"} + }, + "ResourceDataSyncName":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceDataSyncNotFoundException":{ + "type":"structure", + "members":{ + "SyncName":{"shape":"ResourceDataSyncName"} + }, + "documentation":"The specified sync name was not found.
", + "exception":true + }, + "ResourceDataSyncS3BucketName":{ + "type":"string", + "max":2048, + "min":1 + }, + "ResourceDataSyncS3Destination":{ + "type":"structure", + "required":[ + "BucketName", + "SyncFormat", + "Region" + ], + "members":{ + "BucketName":{ + "shape":"ResourceDataSyncS3BucketName", + "documentation":"The name of the Amazon S3 bucket where the aggregated data is stored.
" + }, + "Prefix":{ + "shape":"ResourceDataSyncS3Prefix", + "documentation":"An Amazon S3 prefix for the bucket.
" + }, + "SyncFormat":{ + "shape":"ResourceDataSyncS3Format", + "documentation":"A supported sync format. The following format is currently supported: JsonSerDe
" + }, + "Region":{ + "shape":"ResourceDataSyncS3Region", + "documentation":"The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.
" + } + }, + "documentation":"Information about the target Amazon S3 bucket for the Resource Data Sync.
" + }, + "ResourceDataSyncS3Format":{ + "type":"string", + "enum":["JsonSerDe"] + }, + "ResourceDataSyncS3Prefix":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceDataSyncS3Region":{ + "type":"string", + "max":64, + "min":1 + }, "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", diff --git a/docs/source/conf.py b/docs/source/conf.py index f714220c..6e42e606 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat' # The short X.Y version. version = '1.5.' # The full version, including alpha/beta/rc tags. -release = '1.5.75' +release = '1.5.78' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py index 4a9312b5..ebd51511 100644 --- a/tests/unit/test_utils.py +++ b/tests/unit/test_utils.py @@ -15,9 +15,11 @@ from tests import unittest from dateutil.tz import tzutc, tzoffset import datetime from botocore.compat import six +import copy import mock +import botocore from botocore import xform_name from botocore.compat import OrderedDict, json from botocore.awsrequest import AWSRequest @@ -1635,5 +1637,13 @@ class TestContainerMetadataFetcher(unittest.TestCase): def test_external_host_not_allowed_if_https(self): self.assert_host_is_not_allowed('https://somewhere.com/foo') + +class TestUnsigned(unittest.TestCase): + def test_copy_returns_same_object(self): + self.assertIs(botocore.UNSIGNED, copy.copy(botocore.UNSIGNED)) + + def test_deepcopy_returns_same_object(self): + self.assertIs(botocore.UNSIGNED, copy.deepcopy(botocore.UNSIGNED)) + if __name__ == '__main__': unittest.main()